Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド


5.4.1 クエリパラメータ一覧

クエリパラメータの一覧を次の表に示します。
パラメータ 説明
$query

リソースの属性の値でデータを絞り込むための条件を指定します。

リソース名と属性名をドット(.) で連結して属性を指定します。

object型およびobject[]型の属性は指定できません。

そのほかの絞り込み条件の文法や演算子については、$queryパラメータの説明を参照してください。

指定例:

?$query=ldev.storageDeviceId eq '800000010051'
$offset

検索結果の取得開始位置を10進数で指定します。

02147483647の値が指定できます。

指定例:

?$offset=100&$count=100&$query=ldev.storageDeviceId eq '800000010051'

省略した場合、0が設定されたと見なされます。

$count

検索結果の最大取得件数を10進数で指定します。

116384までの値が指定できます。

指定例:

?$offset=100&$count=100&$query=ldev.storageDeviceId eq '800000010051'

省略した場合、100が設定されたと見なされます。

$fields

検索結果で取得したいリソースまたは属性を指定します。

リソース単位で指定する場合は、そのリソースの属性がすべて取得されます。

リソースの属性を指定する場合は、リソース名と属性名をドット(.) で連結します。

object型およびobject[]型の属性は指定できません。

複数の属性値をコンマ(,) でつないで指定できます。

指定例:

?$fields=ldev.ldevId,ldev.attributes&$query=ldev.storageDeviceId eq '800000010051'

省略した場合、すべての属性が取得されます。

$order-by

検索結果をソートする属性を指定します。

リソース名と属性名をドット(.) で連結して属性を指定します。

属性とソート順を半角スペースで区切って指定します。

object型およびobject[]型の属性は指定できません。

複数の属性値をコンマ(,) でつないで指定できます。優先順位の高いものから先に指定してください。

指定できるソート順を次に示します。

  • ASC:昇順
  • DESC:降順

指定例:

?$order-by=ldev.poolId DESC,ldev.ldevId DESC&$query=ldev.storageDeviceId eq '800000010051'

省略した場合、デフォルトソートキーで昇順にソートします。デフォルトソートキーについては、情報取得の各APIの説明を参照してください。