更新时间:2025-07-25 GMT+08:00

查询 iRack 实例列表

功能介绍

查询iRack实例列表。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID

约束限制

不涉及

取值范围

账号的项目ID

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

region

String

参数解释

局点标识

约束限制

不涉及

取值范围

局点标识

默认取值

不涉及

marker

String

参数解释

下一页查询地址

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

limit

String

参数解释

分页大小

约束限制

不涉及

取值范围

[1,2000]

默认取值

2000

order

String

参数解释

排序

约束限制

不涉及

取值范围

asc 升序

desc 降序

默认取值

不排序

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

iracks

Array of IRack objects

参数解释

机柜集合

约束限制

不涉及

page_info

PageInfo object

参数解释

分页信息

约束限制

不涉及

count

Integer

参数解释

机柜总数

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表5 IRack

参数

参数类型

描述

id

String

参数解释

机柜ID,资源的唯一标识

约束限制

不涉及

取值范围

机柜ID

默认取值

不涉及

name

String

参数解释

机柜名称

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

dc

String

参数解释

机房名称

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

region

String

参数解释

局点信息

约束限制

不涉及

取值范围

局点值

默认取值

不涉及

location

String

参数解释

机柜位置

约束限制

不涉及

取值范围

大小不超过128字节

默认取值

不涉及

size

String

参数解释

机柜尺寸

约束限制

不涉及

取值范围

大小不超过128字节

默认取值

不涉及

unit

String

参数解释

机柜U位

约束限制

不涉及

取值范围

大小不超过128字节

默认取值

不涉及

power

String

参数解释

机柜额定功率

约束限制

不涉及

取值范围

大小不超过128字节,不允许空格、换行符等空白字符

默认取值

不涉及

description

String

参数解释

机柜的描述

约束限制

不涉及

取值范围

长度不超过512字节

默认取值

不涉及

is_cloud_based

String

参数解释

机柜是否是云化纳管柜

约束限制

不涉及

取值范围

true: 是云化纳管柜

false:不是云化纳管柜

默认取值

不涉及

operation_status

Integer

参数解释

冻结状态

约束限制

不涉及

取值范围

0 - 非冻结

其他 - 冻结

默认取值

不涉及

freeze_effect

Integer

参数解释

冻结效果

约束限制

不涉及

取值范围

1 允许释放

2 禁止释放

默认取值

不涉及

tags

tags object

-

表6 tags

参数

参数类型

描述

tags

Array of Tag objects

参数解释

标签信息

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表7 Tag

参数

参数类型

描述

key

String

参数解释

标签key值

约束限制

不涉及

取值范围

  • 不能为空且首尾不能包含空格,最多支持128个字符

  • 可用UTF-8格式表示的任意语种字母、数字和空格

  • 支持部分特殊字符:_.:=+-@

  • 不能以"sys"开头

默认取值

不涉及

value

String

参数解释

标签value值

约束限制

不涉及

取值范围

  • 可以为空但不能缺省,最多支持255个字符

  • 可用UTF-8格式表示的汉字、字母、数字和空格

  • 支持部分特殊字符:_.:/=+-@

默认取值

不涉及

表8 PageInfo

参数

参数类型

描述

next_marker

String

参数解释

下一页查询地址

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

previous_marker

String

参数解释

上一页查询地址

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

current_count

Integer

参数解释

本页返回条目数量

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

状态码:401

表10 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

状态码:429

表11 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

状态码:500

表12 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

请求示例

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

响应示例

状态码:200

irack列表

{
  "iracks" : [ {
    "id" : "01961525-c5fc-780c-92d9-f73eab3fb17c",
    "name" : "raaaaaaaa_698",
    "dc" : "rooooooom_698",
    "location" : "CloudDC_TEST_Bed",
    "size" : "600mm(宽度)*1600mm(深度)*2200mm(高度)",
    "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
}

状态码

状态码

描述

200

irack列表

400

请求参数错误,请求失败

401

请求错误,用户未授权

429

请求错误,请求频率过高

500

服务端内部错误

错误码

请参见错误码