Obtaining All the Thin Provisioning Pool Information

Introduction

Obtains Thin Provisioning Pool information.

If there is more than one piece of information to respond to, the information is stored in ascending order by Number.

Caution

The Thin Provisioning Pool (Flexible Tier Sub Pool) information used by Automated Storage Tiering is not returned.

Request Examples

An example of obtaining the ID and Name of the Thin Provisioning Pool with the Used Status of Warning.

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

Response Examples

{
  "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 to display.

Only the information of the specified Parameter name (Response Body Parameter) is extracted and obtained.

For details about the specification methods, see Property Filter.

tpp_id

Array of integers

Thin Provisioning Pool ID.

Specify the ID of the Thin Provisioning Pool for which you want information.

Input criteria:

You can specify up to 256 values.

status

Array of strings

Status.

Specify the status of the resource for which you want information.

Items	Description
Normal	Normal state.
Maintenance	Maintenance state.
Warning	Preventive maintenance is required.
Error	An error has occurred and maintenance is required.

Input criteria:

You can specify up to 4 values.

max_records

integer

The maximum number of resources for which you want information.

Specify this parameter when you want to limit the number of pieces of information that can be answered.

Input criteria:

The range of allowed values is 1 to 512.

start_number

integer

Default: 0

The first number of the resource for which you want information.

last_get_id

integer

The identifier of the resource for which to obtain further information.

If all resources matching the response conditions cannot be answered at once, next_href is returned.

The last_get_id is the information given to next_href to obtain further information.

used_status

Array of strings

Thin Provisioning Pool usage.

Specify the Used Status of the Thin Provisioning Pool for which you want information.

Items	Description
Normal	The utilization is below the caution threshold.
Attention	The utilization is above the caution threshold and below the warning threshold.
Warning	The utilization is greater than or equal to the warning threshold.

Input criteria:

You can specify up to 3 values.

is_response_volume_id_list

boolean

Whether to return the information on the volumes that belong to the Thin Provisioning Pool using the Volume ID List format.

If this parameter is specified as true, the information on the volumes that belong to the Thin Provisioning Pool is not returned using the Volume Href List format, but returned using the Volume ID List format.

If this parameter is specified as false or is omitted, the Volume Href List format is used to return the information.

If a single Thin Provisioning Pool contains 16384 or more volumes, the information on all the volumes cannot be returned using the Volume Href List format.

To obtain the information on all the volumes belonging to a Thin Provisioning Pool that contains a large number of volumes, set this parameter as true.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

total_count	integer The total number of Resources present in the device. If a filter is applied, this is the total number of Resources that meet the criteria.
list_count	integer Number of Lists to respond.
tpp_list	Array of objects The information that can be obtained with GET /tpp/tpp_id as the number specified for list_count is output. For more information, see "Responses" in Obtaining Thin Provisioning Pool Information.
next_href	string Link to get more information. This item is returned only when it is not possible to respond all information at once. For example, this item is returned if there are more Resources that match the response condition than the number specified by max_records.