全Flexible Tier Pool情報の取得

GET /ftrp

概要説明

Flexible Tier Pool情報を取得します。

応答する情報が複数ある場合、Numberの昇順で情報を格納します。

注意

テナントユーザーの場合、本コマンドを実行することはできません。

リクエスト例

  • Flexible Tier PoolのIDとNameを取得する場合の例です。

    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/ftrp?fields=name"

レスポンス例

{
  "total_count": 512,
  "list_count": 1,
  "ftrp_list": [
    {
      "ftrp_id": 7,
      "ftrp_href": "/api/v1/ftrp/7",
      "number": 0,
      "name": "FTRP_NAME#7",
      "status": "Normal"
    }
  ]
}

Parameters

QUERY PARAMETERS

fields

Array of strings

表示したいParameter。

指定したParameter名(Response Body Parameter)の情報のみを抜き出して取得します。

指定方法の詳細は、表示する項目の絞り込みを参照してください。

ftrp_id

Array of integers

Flexible Tier Pool ID。

情報を取得したいFlexible Tier PoolのIDを指定します。

入力条件:

  • 64個まで指定可能です。

status

Array of strings

ステータス。

情報を取得したいリソースのステータスを指定します。
項目 説明
Normal 正常状態です。
Maintenance 保守状態です。
Warning 予防保守が必要な状態です。
Error 異常が発生し、保守が必要な状態です。

入力条件:

  • 4個まで指定可能です。

Responses

正常に取得できた場合、HTTPステータスコードが200 (OK)となりレスポンスボディを応答します。

RESPONSE BODY

total_count

integer

装置に存在するResourceの総数。

フィルタリングしている場合は、条件に合致するResourceの総数です。

list_count

integer

応答するListの個数。

ftrp_list

Array of objects

GET /ftrp/ftrp_idで取得できる情報を、list_count数分出力します。詳細は、Flexible Tier Pool情報の取得の「Responses」を参照してください。