Obtaining All the Flexible Tier Pool Information

GET /ftrp

Introduction

Obtains Flexible Tier Pool information.

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

Caution

Tenant users cannot execute this command.

Request Examples

  • This is an example of obtaining the ID and Name of the Flexible Tier Pool.

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

Response Examples

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

Array of integers

Flexible Tier Pool ID.

Specify the ID of the Flexible Tier Pool for which you want information.

Input criteria:

  • You can specify up to 64 values.
status

Array of strings

Status.

Specify the status of the resource for which you want information.
Item 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.

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

Array of objects

The information that can be obtained with GET /ftrp/ftrp_id as the number specified for list_count is output. For more information, see "Responses" in Obtaining Flexible Tier Pool Information.