1. 接口描述
接口请求域名： chc.tencentcloudapi.com 。
获取机位列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribePositions。 |
| Version | 是 | String | 公共参数，本接口取值：2023-04-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Offset | 否 | Integer | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。 示例值：1 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。 示例值：5 |
| Filters.N | 否 | Array of Filter | 按照【机架ID】进行过滤。例如：15082。 类型：String 必选：否 按照【机架名称】进行过滤，机架名称例如：M301-E10。 类型：String 必选：否 按照【机房ID】进行过滤，机房ID例如：159。 类型：String 必选：否 按照【机房管理单元ID】进行过滤，机房管理ID例如：568。 类型：String 必选：否 按照【机位状态】进行过滤，机位状态只包含以下四种：机位状态,0 空闲,1 已用,2 不可用,3 预占用,4 预留，例如： 0。 类型：String 必选：否 按照【操作状态】进行过滤，操作状态只包含两种：FINISH 操作完成，PENDING 操作中，例如： PENDING。 类型：String 必选：否 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PositionSet | Array of Position | 客户拥有的机位列表 |
| Total | Integer | 总数 示例值：10 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取机位列表
输入示例
POST / HTTP/1.1
Host: chc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePositions
<公共请求参数>
{}输出示例
{
"Response": {
"PositionSet": [
{
"Height": 2,
"IdcId": 159,
"IdcName": "天津数据备份中心东区DC",
"IdcUnitId": 596,
"IdcUnitName": "天津数据备份中心东区DC1栋M303",
"PlanDeviceType": 8,
"PositionCode": "10",
"PositionId": 158660,
"PositionStatus": 0,
"RackId": 15451,
"RackName": "M303-C14"
}
],
"RequestId": "718aa630-5ccb-4ffa-983b-f627c433379e",
"Total": 37205
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
