1. 接口描述
接口请求域名： bm.tencentcloudapi.com 。
查询物理服务器，可以按照实例，业务IP等过滤
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDevices。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Offset | 是 | Integer | 偏移量 示例值：0 |
| Limit | 是 | Integer | 返回数量，默认为20，最大值为100。 示例值：20 |
| DeviceClassCode | 否 | String | 机型ID，通过接口查询设备型号(DescribeDeviceClass)查询 示例值：PS001v1 |
| InstanceIds.N | 否 | Array of String | 设备ID数组 示例值：cpm-1a2b3c4d |
| WanIps.N | 否 | Array of String | 外网IP数组 示例值：123.123.123.123 |
| LanIps.N | 否 | Array of String | 内网IP数组 示例值：10.0.0.1 |
| Alias | 否 | String | 设备名称 示例值：test |
| VagueIp | 否 | String | 模糊IP查询 示例值：88 |
| DeadlineStartTime | 否 | Timestamp | 设备到期时间查询的起始时间 示例值：2018-01-01 18:00:00 |
| DeadlineEndTime | 否 | Timestamp | 设备到期时间查询的结束时间 示例值：2018-12-01 18:00:00 |
| AutoRenewFlag | 否 | Integer | 自动续费标志 0:不自动续费，1:自动续费 示例值：1 |
| VpcId | 否 | String | 私有网络唯一ID 示例值：vpc-3c7b2102 |
| SubnetId | 否 | String | 子网唯一ID 示例值：subnet-3c7b2102 |
| Tags.N | 否 | Array of Tag | 标签列表 |
| DeviceType | 否 | String | 设备类型，取值有: compute(计算型), standard(标准型), storage(存储型) 等 示例值：standard |
| IsLuckyDevice | 否 | Integer | 竞价实例机器的过滤。如果未指定此参数，则不做过滤。0: 查询非竞价实例的机器; 1: 查询竞价实例的机器。 示例值：0 |
| OrderField | 否 | String | 排序字段 示例值：SubnetId |
| Order | 否 | Integer | 排序方式，取值：0:增序(默认)，1:降序 示例值：1 |
| MaintainStatus | 否 | String | 按照维保方式过滤。可取值为 Maintain: 在保; WillExpire: 即将过保; Expire: 已过保 示例值：Maintain |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 返回数量 示例值：2 |
| DeviceInfoSet | Array of DeviceInfo | 物理机信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询物理机信息
输入示例
https://bm.tencentcloudapi.com/?Action=DescribeDevices
&Offset=0
&Limit=20
&VpcId=vpc-3c7b2102
&DeviceClassCode=PS001v1
&Alias=test
&VagueIp=88
&DeadlineStartTime=2018-01-01 18:00:00
&DeadlineEndTime=2018-12-01 18:00:00
&AutoRenewFlag=1
&Tags.0.TagKey=testkey
&Tags.0.TagValues.0=testval
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 2,
"DeviceInfoSet": [
{
"InstanceId": "tcpm-q0hcvsrn",
"VpcId": "vpc-3c7b2102",
"SubnetId": "subnet-et5bm4jl",
"DeviceStatus": 4,
"OperateStatus": 1,
"OsTypeId": 6,
"RaidId": 2,
"Alias": "ami-test",
"AppId": 251000873,
"Zone": "ap-shanghai-bls-2",
"WanIp": "",
"LanIp": "10.188.1.2",
"DeliverTime": "2017-09-28 01:11:11",
"Deadline": "2018-10-01 00:00:00",
"AutoRenewFlag": 1,
"DeviceClassCode": "PS001v1",
"CpmPayMode": 2,
"DhcpIp": "100.81.128.24",
"VpcName": "BMGZHW-206002",
"SubnetName": "subnet0",
"MaintainStatus": "Maintain",
"MaintainMessage": "有厂商维保服务，可继续使用",
"VpcCidrBlock": "10.188.0.0/16",
"SubnetCidrBlock": "10.188.1.0/24",
"IsLuckyDevice": 0,
"Tags": [
{
"TagKey": "testval",
"TagValues": [
"____TIMI _____",
"testval"
]
}
]
},
{
"InstanceId": "tcpm-nxl2p7t7",
"VpcId": "vpc-3c7b2102",
"SubnetId": "subnet-et5bm4jl",
"DeviceStatus": 4,
"OperateStatus": 9,
"OsTypeId": 50,
"RaidId": 2,
"Alias": "test用",
"AppId": 251000873,
"Zone": "ap-shanghai-bls-2",
"WanIp": "",
"LanIp": "10.188.1.6",
"DeliverTime": "2018-02-08 17:26:01",
"Deadline": "2018-10-01 00:00:00",
"AutoRenewFlag": 1,
"DeviceClassCode": "PS100v1",
"CpmPayMode": 2,
"DhcpIp": "100.81.128.22",
"VpcName": "BMGZHW-206002",
"MaintainStatus": "Maintain",
"MaintainMessage": "有厂商维保服务，可继续使用",
"SubnetName": "subnet0",
"VpcCidrBlock": "10.188.0.0/16",
"SubnetCidrBlock": "10.188.1.0/24",
"IsLuckyDevice": 0,
"Tags": [
{
"TagKey": "testval",
"TagValues": [
"testval"
]
}
]
}
],
"RequestId": "7e733b67-48fb-4cbe-99c3-0eb6b81aa759"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| UnauthorizedOperation | 未授权操作。 |
