更新时间:2026-05-18 GMT+08:00

查询 IDC 列表 - ListIDcs

功能介绍

查询 IDC 列表

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

clouddc:idc:list

List

-

-

-

-

URI

GET /v1/{project_id}/idcs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

region

是

String

参数解释:

局点信息

约束限制:

不涉及

取值范围:

局点值

默认取值:

不涉及

limit

否

String

参数解释:

分页查询时每页行数。

约束限制:

不涉及

取值范围:

[1-2000]

默认取值:

2000

order

否

String

参数解释:

排序方式

约束限制:

不涉及

取值范围:

  • asc 升序

  • desc 降序

默认取值:

不涉及

marker

否

String

参数解释:

下一页查询地址

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

idcs

Array of IDc objects

参数解释:

机房集合

约束限制:

不涉及

page_info

PageInfo object

参数解释:

分页信息

约束限制:

不涉及

count

Integer

参数解释:

机房总数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 IDc

参数

参数类型

描述

name

String

参数解释:

机房名称

约束限制:

不涉及

取值范围:

长度不超过256字节

默认取值:

不涉及

irack_num

Integer

参数解释:

包含的机柜数量

约束限制:

不涉及

取值范围:

局点值

默认取值:

不涉及

id

String

参数解释:

机房ID

约束限制:

不涉及

取值范围:

长度不超过128字节

默认取值:

不涉及

region

String

参数解释:

局点信息

约束限制:

不涉及

取值范围:

局点值

默认取值:

不涉及

description

String

参数解释:

机房描述

约束限制:

不涉及

取值范围:

长度不超过512字节

默认取值:

不涉及

表6 PageInfo

参数

参数类型

描述

next_marker

String

参数解释:

下一页查询地址

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

previous_marker

String

参数解释:

上一页查询地址

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

current_count

Integer

参数解释:

本页返回条目数量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

error_code

String

参数解释:

错误码

约束限制:

不涉及

取值范围:

不涉及

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

error_code

String

参数解释:

错误码

约束限制:

不涉及

取值范围:

不涉及

状态码:429

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

error_code

String

参数解释:

错误码

约束限制:

不涉及

取值范围:

不涉及

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

error_code

String

参数解释:

错误码

约束限制:

不涉及

取值范围:

不涉及

请求示例

查询 IDC 列表

GET https://{endpoint}/v1/{project_id}/idcs

响应示例

状态码:200

IDC 列表

{
  "idcs" : [ {
    "id" : "019674ed-07c1-7496-b6a8-96989d73efa9",
    "name" : "EquipmentRoom_001",
    "irack_num" : 1016,
    "description" : "描述测试Describe the test-中划线_xaihauxia",
    "region" : "cn-southwest-242"
  } ],
  "page_info" : {
    "next_marker" : "01981c9a-bf80-7265-b3d3-6e2b34fcced5",
    "previous_marker" : "019674ed-07c1-7496-b6a8-96989d73efa9",
    "current_count" : 606
  },
  "count" : 606
}

状态码

状态码

描述

200

IDC 列表

400

请求参数错误,请求失败

401

请求错误,用户未授权

429

请求错误,请求频率过高

500

服务端内部错误

错误码

请参见错误码。