1.2.8 クエリパラメータ
クエリパラメータでは，リクエストに検索条件を指定することで，レスポンスの出力内容をフィルタリングしたり，ソートしたりすることができます。
(1) すべてのAPIで指定できるクエリパラメータ
次の表に示すパラメータは，すべてのAPIで指定できます。
パラメータ |
説明 |
指定できる値 |
デフォルト値 |
|---|---|---|---|
Alt |
リクエストのContent-TypeヘッダーやAcceptヘッダーと同様に，入出力のデータ形式を指定できます。 |
json |
− |
（凡例）−：該当しません。
(2) 一部のAPIで指定できるクエリパラメータ
次の表に示すパラメータは，リソース(例：監視プロファイル，仮想マシンなど)の一覧を取得する際に指定できます。APIごとに使用可能なパラメータが異なる場合があります。詳細は各APIの説明を参照してください。
パラメータ |
説明 |
指定できる値※ |
デフォルト値 |
|---|---|---|---|
$query |
指定した条件でフィルタリングを行います。 |
「1.2.9 HQL規格の使用」を参照してください。 |
− |
$order-by |
指定されたメンバー名でソートします。 |
メンバー名 [{ASC| DESC}](, メンバー名 [{ASC| DESC}]) ASC:昇順 DESC:降順 |
ASC |
$offset |
情報を取得する先頭オブジェクトの位置を指定します。レスポンスに含めるオブジェクトの最大数は$countで指定します。$offsetよりもpageが優先されます。 |
0～2147483647 |
0 |
$count |
$offsetに指定した先頭オブジェクトの位置を起点に，レスポンスに含めるオブジェクトの最大数を指定します。$countよりもpageSizeが優先されます。なお，$countと$offsetの合計が2,147,483,647を超える場合，$offsetに指定した値から2,147,483,647番目までのオブジェクトを取得します |
1～2147483647 |
100 |
page |
リソースを，ページ単位で分割する場合に，指定したページの情報を取得します。pageSizeを同時に指定する必要があります。$offsetよりもpageが優先されます。 |
1～2147483647 |
− |
pageSize |
1ページに表示するオブジェクトの最大数を指定します。$countよりもpageSizeが優先されます。 |
1～2147483647 |
− |
（凡例）−：該当しません。
- 注※
URLとして表現できない文字列を値に指定したい場合は，UTF-8形式でURLエンコードしてください。
pageSizeには1ページに表示するオブジェクトの最大数を指定し，pageには分割されたページのうちの何ページ目を表示するかを指定します。pageおよびpageSizeを指定すると，Paginationオブジェクトに全リソース数とページ数が返却されます。この値によって次のページがあるかどうかを判断できます。
なお，pageおよびpageSizeは次の式のとおり，$offsetの値に変換されて利用されます。
$offset=pageSize*(page-1)
そのため，pageおよびpageSizeが$offsetの範囲を超えた場合，ステータスコードは400のBad Requestが返却されます。