全Thin Provisioning Pool情報の取得

GET /tpp

概要説明

Thin Provisioning Pool情報を取得します。

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

注意

Automated Storage Tieringで使用されているThin Provisioning Pool (Flexible Tier Sub Pool)の情報は応答しません。

リクエスト例

  • Used StatusがWarningのThin Provisioning PoolのIDとNameを取得する場合の例です。 
    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/tpp?used_status=Warning&fields=name"

レスポンス例

{
  "total_count": 512,
  "list_count": 1,
  "tpp_list": [
    {
      "tpp_id": 0,
      "tpp_href": "/api/v1/tpp/0",
      "name": "DataStore#0",
      "number": 0,
      "status": "Normal",
      "detail_status": "Available",
      "used_status": "Normal",
      "is_data_reduction_error": false,
      "physical_capacity": 2097152,
      "provisioned_capacity": 1048576,
      "used_capacity": 524288,
      "used_rate": 20,
      "provisioned_rate": 50,
      "warning_threshold": 90,
      "attention_threshold": 75,
      "is_cm_encryption_enabled": false,
      "chunk_size": 21,
      "drive_type": "Online",
      "level": "RAID5",
      "raidgroup_href_list": [
        "/api/v1/raidgroup/0",
        "/api/v1/raidgroup/1"
      ],
      "is_compression_enabled": true,
      "is_deduplication_enabled": false,
      "data_reduction_rate": 90,
      "data_size_before_reduction": 3145728,
      "data_size_after_reduction": 314572,
      "gc_speed": 0,
      "volume_href_list": [
        "/api/v1/volume/3",
        "/api/v1/volume/100001",
        "/api/v1/volume/200001",
        "/api/v1/volume/300000",
        "/api/v1/volume/400000"
      ]
    }
  ]
}

Parameters

QUERY PARAMETERS

fields

Array of strings

表示したいParameter。

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

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

Array of integers

Thin Provisioning Pool ID。

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

入力条件：

  • 256個まで指定可能です。
status

Array of strings

ステータス。

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

入力条件：

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

integer

情報を取得したいリソースの最大数。

応答する情報数を制限したい場合に指定してください。

入力条件：

  • 指定可能な範囲は1～512です。
start_number

integer

Default: 0

情報を取得したいリソースの先頭のNumber。
last_get_id

integer

続きの情報を取得するためのリソースの識別子。

一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_hrefが返却されます。

last_get_idはnext_hrefに付与される、続きの情報を取得するための情報です。
used_status

Array of strings

Thin Provisioning Poolの使用状況。

情報を取得したいThin Provisioning PoolのUsed Statusを指定します。
項目 説明
Normal 使用率が注意閾値未満です。
Attention 使用率が注意閾値以上、警告閾値未満です。
Warning 使用率が警告閾値以上です。

入力条件：

  • 3個まで指定可能です。
is_response_volume_id_list

boolean

Thin Provisioning Poolに属するVolume情報をVolume ID List型式で応答するかどうか。

trueを指定した場合、Thin Provisioning Poolに属するVolume情報を、Volume Href ListではなくVolume ID List型式で応答します。

falseを指定した場合または指定を省略した場合、Volume Href List型式で応答します。

1つのThin Provisioning PoolにVolumeが16384以上存在する場合、Volume Href List型式ではすべてのVolume情報を応答することができません。

大量にVolumeが存在するThin Provisioning Poolに属するVolume情報をすべて取得したい場合は、本Parameterでtrueを指定してください。

Responses

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

RESPONSE BODY

total_count

integer

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

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

integer

応答するListの個数。
tpp_list

Array of objects

GET /tpp/tpp_idで取得できる情報を、list_count数分出力します。詳細は、Thin Provisioning Pool情報の取得の「Responses」を参照してください。
next_href

string

続きの情報を取得するためのLink。

一度にすべての情報を応答しきることができなかった場合に限り応答します。

例えば、max_recordsで指定した個数以上に応答条件に合致するResourceが存在する場合などに応答します。