Help Center/ Cloud Data Center / API Reference/ API/ Rack Management/ Querying the Intelligent Rack List

Updated on 2025-12-12 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Intelligent Rack List

Function

This API is used to query the intelligent rack list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/iracks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. Constraints: N/A Value range: Project IDs of the account Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
region	Yes	String	Definition: Site ID. Constraints: N/A Value 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 Value range: [1,2000] Default value: 2000
order	No	String	Definition Sorting. Constraints N/A Range asc: ascending order. desc: descending order. Default Value Unsorted

Request Parameters

**Table 3** Request header parameters
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 Value 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 Value 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 Data center 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 Value range: Maximum length: 128 characters. Default value: N/A
size	String	Definition: Rack dimensions. Constraints: N/A Value range: Maximum length: 128 characters. Default value: N/A
unit	String	Definition: Rack U space. Constraints: N/A Value range: Maximum length: 128 characters. Default value: N/A
power	String	Definition: Rated power of a rack. Constraints: N/A Value range: Maximum length: 128 characters. It cannot contain spaces or line breaks. Default value: N/A
description	String	Definition: Rack description. Constraints: N/A Value range: Maximum length: 512 characters Default value: N/A
is_cloud_based	String	Definition: Whether racks are managed on the cloud. Constraints: N/A Value 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: unfrozen Other: frozen Default Value N/A
freeze_effect	Integer	Definition Frozen effect. Constraints N/A Range 1: Racks can be released. 2: Racks cannot be released. Default Value N/A
tags	Array of Tag objects	Definition Tag information. Constraints N/A Range N/A Default Value N/A

**Table 6** Tag
Parameter	Type	Description
key	String	Definition Tag key. Constraints N/A Range The tag key: Cannot be empty and cannot start or end with spaces. Maximum length: 128 characters. Can contain letters, digits, and spaces in UTF-8 format. Can contain the following special characters: _.:=+-@ Cannot start with _sys_. The tag key cannot be empty when you delete a tag. Default Value N/A
value	String	Definition Tag value. Constraints N/A Range Can be null but not the default. Max characters: 255. Can contain letters, digits, and spaces in UTF-8 format. Can contain the following special characters: _.:/=+-@ Default Value N/A

**Table 7** 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 Number of records returned on this page. Constraints N/A Range N/A Default Value N/A

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error description. 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 9** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error description. 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 10** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error description. 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 11** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error description. 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) x 1,600 mm (depth) x 2,200 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 due to user authorization not granted.
429	Request error due to too frequent requests.
500	Internal server error.