Listing Intelligent Racks

Function

This API is used to query the intelligent rack list.

Calling Method

For details, see Calling APIs.

URI

GET https://www.example.com/v1/{project_id}/iracks

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition The project ID. Constraints N/A Range The project ID of the account Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
region	Yes	String	Definition Site ID. Constraints N/A Range Site ID Default Value N/A
marker	No	String	Definition Query address of the next page. Constraints N/A Range N/A Default Value N/A
limit	No	String	Definition Page size. Constraints N/A Range [1,2000] Default Value 2000
order	No	String	Definition Sorting order. Constraints N/A Range asc: The query results are displayed in ascending order. desc: The query results are displayed in the descending order. Default Value None

Request Parameters

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
iracks	Array of IRack objects	Definition A set of racks. Constraints N/A
page_info	PageInfo object	Definition Pagination information. Constraints N/A
count	Integer	Definition The total number of racks. Constraints N/A Range N/A Default Value N/A

**Table 5** IRack
Parameter	Type	Description
id	String	Definition Unique ID of a rack. Constraints N/A Range Rack ID Default Value N/A
name	String	Definition Rack name. Constraints N/A Range N/A Default Value N/A
dc	String	Definition Equipment room name. Constraints N/A Range N/A Default Value N/A
region	String	Definition Region information. Constraints N/A Range Regions Default Value N/A
location	String	Definition Rack location. Constraints N/A Range Maximum length: 128 bytes Default Value N/A
size	String	Definition Rack size. Constraints N/A Range Maximum length: 128 bytes Default Value N/A
unit	String	Definition Rack unit (U) Constraints N/A Range Maximum length: 128 bytes Default Value N/A
power	String	Definition Rated power of a rack. Constraints N/A Range Maximum length: 128 bytes. It cannot contain spaces or line breaks. Default Value N/A
description	String	Definition Rack description. Constraints N/A Range Maximum length: 512 bytes Default Value N/A
is_cloud_based	String	Definition Whether racks are managed on the cloud. Constraints N/A Range true: Racks are managed on the cloud. false: Racks are not managed on the cloud. Default Value N/A
operation_status	Integer	Definition Whether racks are frozen. Constraints N/A Range 0: Not frozen Other: Frozen Default Value N/A
freeze_effect	Integer	Definition Frozen effect. Constraints N/A Range 1: Racks can be released. 2: Racks are not allowed to be released. Default Value N/A
tags	tags object	-

**Table 6** tags
Parameter	Type	Description
tags	Array of Tag objects	Definition Tags. Constraints N/A Range N/A Default Value N/A

**Table 7** Tag
Parameter	Type	Description
key	String	Definition Tag key. Constraints N/A Range The value cannot be empty and cannot start or end with spaces. A maximum of 128 characters are supported. The value can contain letters, digits, and spaces in UTF-8 format. The value can contain the following special characters: _.:=+-@ The value cannot start with sys. Default Value N/A
value	String	Definition Tag value. Constraints N/A Range The value can contain a maximum of 255 characters. It can be empty but cannot be the default. The value can be letters, digits, and spaces in UTF-8 format. The value can contain the following special characters: _.:/=+-@ Default Value N/A

**Table 8** PageInfo
Parameter	Type	Description
next_marker	String	Definition Query address of the next page. Constraints N/A Range N/A Default Value N/A
previous_marker	String	Definition Query address of the previous page. Constraints N/A Range N/A Default Value N/A
current_count	Integer	Definition The number of items returned on this page. Constraints N/A Range N/A Default Value N/A

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error message. Constraints N/A Range N/A Default Value N/A
error_code	String	Definition Error code. Constraints N/A Range N/A

Status code: 401

**Table 10** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error message. Constraints N/A Range N/A Default Value N/A
error_code	String	Definition Error code. Constraints N/A Range N/A

Status code: 429

**Table 11** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error message. Constraints N/A Range N/A Default Value N/A
error_code	String	Definition Error code. Constraints N/A Range N/A

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error message. Constraints N/A Range N/A Default Value N/A
error_code	String	Definition Error code. Constraints N/A Range N/A

Example Requests

GET https://{endpoint}/v1/{project_id}/iracks?region={region}

Example Responses

Status code: 200

Intelligent rack list is returned.

{
  "iracks" : [ {
    "id" : "01961525-c5fc-780c-92d9-f73eab3fb17c",
    "name" : "raaaaaaaa_698",
    "dc" : "rooooooom_698",
    "location" : "CloudDC_TEST_Bed",
    "size" : "600 mm (width)*1600 mm (depth)*2200 mm (height)",
    "unit" : "47U",
    "power" : "8KW",
    "description" : "123123",
    "is_cloud_based" : "true",
    "operation_status" : 0,
    "freeze_effect" : 1,
    "tags" : [ {
      "key" : "chennantest",
      "value" : "1234556"
    }, {
      "key" : "BQ0715",
      "value" : "BQZ01-XG"
    } ]
  } ],
  "page_info" : {
    "next_marker" : "0196ebc1-494e-7e97-be8f-9fd00ac370fa",
    "previous_marker" : "01961525-c5fc-780c-92d9-f73eab3fb17c",
    "current_count" : 1000
  },
  "count" : 4185
}

Status Codes

Status Code	Description
200	Intelligent rack list is returned.
400	Invalid request parameter.
401	Request error. User not authorized.
429	Request error. Too many requests.
500	Internal server error.