云托付物理服务器获取设备列表

1. 接口描述

接口请求域名： chc.tencentcloudapi.com 。

获取设备列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDeviceList。
Version	是	String	公共参数，本接口取值：2023-04-18。
Region	是	String	公共参数，详见产品支持的地域列表。
DeviceType	是	String	设备类型 server 服务器，netDevice 网络设备，otherDevice 其他设备示例值：server
Filters.N	否	Array of Filter	rack-id 按照【机架ID】进行过滤。例如：15082。类型：String 必选：否 sn 按照【设备 SN 码】进行过滤，设备 SN 例如：TEN948P004。类型：String 必选：否 idc-id 按照【机房ID】进行过滤，机房ID例如：159。类型：String 必选：否 idc-unit-id 按照【机房管理单元ID】进行过滤，机房管理ID例如：568。类型：String 必选：否 server-type-id 按照【机器子类型】进行过滤，只包含以下几种：1:服务器, 2:Twins主机, 3:Twins子机,5:虚拟机, 6:2U4S主机, 7:2U4S子机,8 Rack主机,9 Rack子机，例如： 1。类型：String 必选：否 status 按照【设备状态】进行过滤，操作状态只包含：POWER_ON 设备开电，POWER_OFF 设备关电，RACK_OFF 未上架，MOVING 搬迁中。例如： POWER_OFF。类型：String 必选：否 svr-is-special 按照【是否】进行过滤，支持 0：自有，1 租用。例如： 1。类型：String 必选：否
Offset	否	Integer	偏移量，默认为0 示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为1000 示例值：100
DstService	否	String	传入目标服务，返回允许进行此服务的设备列表；可以和Filters一起使用。允许的值：('rackOn', 'powerOn', 'powerOff', 'rackOff', 'quit', 'moving'，'netDeviceCommon', 'serverCommon') 示例值：rackOn

3. 输出参数

参数名称	类型	描述
Total	Integer	总数示例值：2
DeviceSet	Array of Device	服务器列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询服务器设备列表

输入示例

POST / HTTP/1.1
Host: chc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceList
<公共请求参数>

{
    "DeviceType": "server"
}

输出示例

{
    "Response": {
        "DeviceSet": [
            {
                "AssetId": "TH24122400001",
                "DeviceType": "server",
                "IdcId": 159,
                "IdcName": "天津数据备份中心东区DC",
                "IdcUnitId": 596,
                "IdcUnitName": "天津数据备份中心东区DC1栋M303",
                "Ip": "",
                "ModelVersion": "DELL R420-V2",
                "OnshelfDate": "2025-01-02",
                "PositionCode": 20,
                "PowerOnTime": "2025-01-02",
                "RackId": 15452,
                "RackName": "M303-C15",
                "ServerTypeId": 1,
                "Sn": "20241218chc0001",
                "Status": "POWER_OFF",
                "SvrIsSpecial": 0
            }
        ],
        "RequestId": "13e97f35-2559-4a69-a4ea-38c5d9f42c80",
        "Total": 2513
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。