查询物理机信息

最近更新时间:2018-11-06 11:06:33

1. 接口描述

接口请求域名: bm.tencentcloudapi.com 。

查询物理服务器,可以按照实例,业务IP等过滤

默认接口请求频率限制:10次/秒。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDevices
Version String 公共参数,本接口取值:2018-04-23
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 偏移量
Limit Integer 返回数量
DeviceClassCode String 机型ID,通过接口查询设备型号(DescribeDeviceClass)查询
InstanceIds.N Array of String 设备ID数组
WanIps.N Array of String 外网IP数组
LanIps.N Array of String 内网IP数组
Alias String 设备名称
VagueIp String 模糊IP查询
DeadlineStartTime Timestamp 设备到期时间查询的起始时间
DeadlineEndTime Timestamp 设备到期时间查询的结束时间
AutoRenewFlag Integer 自动续费标志 0:不自动续费,1:自动续费
VpcId String 私有网络唯一ID
SubnetId String 子网唯一ID
Tags.N Array of Tag 标签列表
DeviceType String 设备类型,取值有: compute(计算型), standard(标准型), storage(存储型) 等
IsLuckyDevice Integer 竞价实例机器的过滤。如果未指定此参数,则不做过滤。0: 查询非竞价实例的机器; 1: 查询竞价实例的机器。
OrderField String 排序字段
Order Integer 排序方式,取值:0:增序(默认),1:降序

3. 输出参数

参数名称 类型 描述
TotalCount Integer 返回数量
DeviceInfoSet Array of DeviceInfo 物理机信息列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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": {
    "DeviceInfoSet": [
      {
        "Alias": "ami-test",
        "AppId": 251000873,
        "AutoRenewFlag": 1,
        "CpmPayMode": 2,
        "Deadline": "2018-10-01 00:00:00",
        "DeliverTime": "2017-09-28 01:11:11",
        "DeviceClassCode": "PS001v1",
        "DeviceStatus": 4,
        "DhcpIp": "100.81.128.24",
        "InstanceId": "tcpm-q0hcvsrn",
        "IsLuckyDevice": 0,
        "LanIp": "10.188.1.2",
        "OperateStatus": 1,
        "OsTypeId": 6,
        "RaidId": 2,
        "SubnetCidrBlock": "10.188.1.0/24",
        "SubnetId": "subnet-et5bm4jl",
        "SubnetName": "subnet0",
        "Tags": [
          {
            "TagKey": "testval",
            "TagValues": [
              "____TIMI _____",
              "testval"
            ]
          }
        ],
        "VpcCidrBlock": "10.188.0.0/16",
        "VpcId": "vpc-3c7b2102",
        "VpcName": "BMGZHW-206002",
        "WanIp": "",
        "Zone": "ap-shanghai-bls-2"
      },
      {
        "Alias": "test用",
        "AppId": 251000873,
        "AutoRenewFlag": 1,
        "CpmPayMode": 2,
        "Deadline": "2018-10-01 00:00:00",
        "DeliverTime": "2018-02-08 17:26:01",
        "DeviceClassCode": "PS100v1",
        "DeviceStatus": 4,
        "DhcpIp": "100.81.128.22",
        "InstanceId": "tcpm-nxl2p7t7",
        "IsLuckyDevice": 0,
        "LanIp": "10.188.1.6",
        "OperateStatus": 9,
        "OsTypeId": 50,
        "RaidId": 2,
        "SubnetCidrBlock": "10.188.1.0/24",
        "SubnetId": "subnet-et5bm4jl",
        "SubnetName": "subnet0",
        "Tags": [
          {
            "TagKey": "testval",
            "TagValues": [
              "testval"
            ]
          }
        ],
        "VpcCidrBlock": "10.188.0.0/16",
        "VpcId": "vpc-3c7b2102",
        "VpcName": "BMGZHW-206002",
        "WanIp": "",
        "Zone": "ap-shanghai-bls-2"
      }
    ],
    "RequestId": "7e733b67-48fb-4cbe-99c3-0eb6b81aa759",
    "TotalCount": 2
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
FailedOperation 操作失败
InvalidParameter 参数错误
UnauthorizedOperation 未授权操作