ページング構文

API検索リクエストで返される結果を制限するには、 HTTP GET。 IBM® QRadar® リソースのリストを返すAPIエンドポイントのほとんどは、 Range ヘッダーパラメーターをサポートしています。

Range パラメーターの構文は、そのパラメーターをサポートしているすべてのエンドポイントで一貫性があります。エンドポイントの資料を参照し、Range パラメーターがそれに適用されるかどうかを判別してください。 Range 構文の制限事項はすべて、そのエンドポイントの説明に記載されています。

注: Range パラメーターは、 sort、 filter、および fields パラメーターとは異なり、常にヘッダー・パラメーターとして送信されます。通常、これらのパラメーターは照会パラメーターです。

デフォルトでは、対話式 API 資料ページで最初の 50 件のレコードのみが Range パラメーターに対して返されます。エンドポイントの Range 値を変更することができます。ただし、大規模な結果セットを要求した場合、対話式 API 資料ページのパフォーマンスに悪影響を及ぼす可能性があります。

Range ヘッダー・パラメーター

ページング要求は Range ヘッダー・パラメーターで指定します。ゼロから始まる以下の構文を使用します。

Range: items=x-y

ページングを使用する要求の応答には Content-Range ヘッダーが含まれます。このヘッダーには、コンテンツ範囲内で返されたレコードの数が以下の形式で示されます。

Content-Range: items x-y/total number of records received

例えば、最初の 5 件のレコードを返すようにする場合、要求ヘッダーに以下のパラメーターを含めます。

"Range: items= 0-4"

その要求の応答ヘッダーは、以下の情報を返します。

Content-Range: items 0-4/5

要求された範囲がレコードの数を超える場合は、指定された範囲内のすべてのレコードが返されます。以下の例では、最初の 100 件のレコードが要求されています。

"Range: items= 0-99"

ただし、合計で 12 件のレコードしかありません。応答では、以下のように、指定された範囲内のすべてのレコードが返されます。

Content-Range: items 0-11/12

要求された範囲がレコードの量の限界を超える場合は、レコードは何も返されません。以下の例では、最初の 3 から 5 の範囲のレコードが要求されています。

"Range: items = 3-5"

ただし、レコードの数が 3 件より少ないため、レコードは何も返されません。

Content-Range: items */3