Obtaining Thin Provisioning Pool Information

GET /tpp/{tpp_id}

Introduction

Obtains Thin Provisioning Pool information.

Caution

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

Request Examples

  • This is an example of obtaining Thin Provisioning Pool ID 5 information.

    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/tpp/5"

Response Examples

{
  "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

PATH PARAMETERS

tpp_id

(required)

integer

Thin Provisioning Pool ID.

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.
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

tpp_id

integer

An ID that identifies the Thin Provisioning Pool.
tpp_href

string

Link to a Resource in the Thin Provisioning Pool.
name

string

Friendly Name of the Thin Provisioning Pool.
number

integer

Thin Provisioning Pool Number.

This is the Thin Provisioning Pool identifier used in ETERNUS Web GUI or ETERNUS CLI.
status

string

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

string

Detailed status of the Thin Provisioning Pool.
Items Description
Available Normal state.
Maintenance Forced recovery in progress.
Readying All physical allocated space is raw.
Partially_Readying Some physical allocated space is unformatted.
Exposed Available, but the configuration drive is no longer redundant.
Blockade Blockade state.
Broken Failed state.
Data_Lost Data is lost.
used_status

string

Thin Provisioning Pool usage.
Items Description
Normal The utilization is below the caution threshold.
Attention The utilization is above the caution threshold and below the warning threshold. If a Data Container Volume exists, the usage also becomes Attention when the volume capacity exceeds the threshold (80%).
Warning The utilization is greater than or equal to the warning threshold.
is_data_reduction_error

boolean

Whether the Data Reduction function (Deduplication and/or Compression) is abnormal.

If true, the Data Container Volume has failed due to hardware failure, etc., and Data Reduction is not working properly.
physical_capacity

integer

Total physical capacity of the Thin Provisioning Pool.

The unit is MB.
provisioned_capacity

integer

Total logical capacity of Volumes belonging to the Thin Provisioning Pool.

The unit is MB.

The capacity of the Data Container Volume is not included in the total logical capacity.
used_capacity

integer

Sum of the physically allocated capacity of Volumes belonging to the Thin Provisioning Pool.

The unit is MB.
used_rate

integer

Thin Provisioning Pool utilization.

The unit is %.

This item represents the percentage of used capacity (Used Capacity) to the total physical capacity (Physical Capacity).
provisioned_rate

integer

The Provisioning rate of the Thin Provisioning Pool.

The unit is %.

This item represents the ratio of the total logical capacity (Provisioned Capacity) to the total physical capacity (Physical Capacity).

This item is not returned if Data Reduction is enabled.
warning_threshold

integer

Warning threshold.

The unit is %.

If the Thin Provisioning Pool utilization (percentage of used capacity to the total physical capacity) exceeds this threshold, the usage transitions to Warning.
attention_threshold

integer

Attention threshold.

The unit is %.

If the Thin Provisioning Pool utilization (percentage of used capacity to the total physical capacity) exceeds this threshold, the usage transitions to Attention.

If there is no Attention threshold setting, 0 is displayed.
is_cm_encryption_enabled

boolean

Whether encryption by CM is enabled.

If true, the data in the Thin Provisioning Pool is encrypted by the CM.
chunk_size

integer

Chunk Size of the Thin Provisioning Pool.

The unit is MB.

The smallest unit of physical space to assign to a Volume.
drive_type

string

Type of Drive with which the Thin Provisioning Pool is configured.
Items Description
Online Online HDD
Nearline Nearline HDD
SSD SAS SSD
NVMe_SSD NVMe SSD
Online_SED Online HDD SED
Nearline_SED Nearline HDD SED
SSD_SED SAS SSD SED
NVMe_SSD_SED NVMe SSD SED
level

string

The RAID Level of the RAID Groups that configure the Thin Provisioning Pool.
Items Description
RAID0 Striping
RAID1 Mirroring
RAID5 High Capacity
RAID6 High Reliability
RAID10 High Performance
RAID6FR RAID6 (Fast Recovery)
raidgroup_href_list

Array of strings

Link to a Resource of the RAID Group that configures the Thin Provisioning Pool.
is_compression_enabled

boolean

Whether Compression is enabled.

If true, Compression is performed on the Data written to the Volume in the Thin Provisioning Pool.
is_deduplication_enabled

boolean

Whether Deduplication is enabled.

If true, Deduplication is performed on the Data written to the Volume in the Thin Provisioning Pool.
data_reduction_rate

integer

Capacity reduction rate.

The unit is %.

The ratio of the size of data reduced by Data Reduction (Deduplication and/or Compression) to the size of data written.

This item is not returned if the retrieval fails or Data Reduction is disabled.
data_size_before_reduction

integer

Data size before reduction.

The unit is MB.

The sum of the pre-reduction sizes of the data written to the Volume.

This item is not returned if the retrieval fails or Data Reduction is disabled.
data_size_after_reduction

integer

Data size after reduction.

The unit is MB.

The sum of the reduced sizes of the data written to the Volume.

This item is not returned if the retrieval fails or Data Reduction is disabled.
gc_speed

integer

How fast the Garbage Collection is running.

The unit is MB/s.

The operating speed of the deallocation process for physically allocated space that is no longer needed by Data Reduction is returned.

This item is not returned if the retrieval fails or Data Reduction is disabled.
volume_href_list

Array of strings

Link to a Resource of the Volume that belongs to the Thin Provisioning Pool.

If is_response_volume_id_list is true, no response is made.

Replies with up to 16384 Volume information.
volume_id_list

Array of integers

ID of Volumes belonging to the Thin Provisioning Pool.

This item is returned if is_response_volume_id_list is true.