表示する項目の絞り込み

GETによる情報取得では、Queryにfields オプションを指定することで、表示する項目を絞ることができます。

fieldsに、表示したい項目を以下のように "," 区切りで指定してください。

fieldsの指定がない場合、すべての項目を取得します。

例)

https://192.168.1.1:5665/api/v1/volume?fields=name,status

リソースID ({リソース名}_id) はfieldsの指定有無にかかわらず応答します。

リスト形式で応答される情報を抜き出して取得したい場合は、リスト内のパラメーター名を指定してください。例えば、GET /volumeにてボリューム名のみを取得したい場合は、fields=volume_list.nameではなく、fields=nameとなります。

レスポンスボディで応答されるパラメーター名は基本的にすべてfieldsで指定可能ですが、以下のパラメーター名をfieldsに指定することはできません。これらはfieldsの指定にかかわらず、応答条件を満たした場合に応答します。

• 応答をサポートしていないパラメーター名。

• 以下のパラメーター名。

  • total_count

  • list_count

  • next_href

• APIコマンド名となっているリソースのオブジェクト名 ({リソース名}_list) 。

  例えば、GET /tpp?fields=tpp_listは指定不可です。一方、GET /tpp?fields=raidgroup_listは指定可能です。