查询设备位置信息

最近更新时间:2018-12-27 21:14:26

1. 接口描述

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

查询服务器所在的位置,如机架,上联交换机等信息

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDevicePosition
Version String 公共参数,本接口取值:2018-04-23
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 偏移量
Limit Integer 数量限制
VpcId String 私有网络ID
SubnetId String 子网ID
InstanceIds.N Array of String 实例ID列表
Alias String 实例别名

3. 输出参数

参数名称 类型 描述
TotalCount Integer 返回数量
DevicePositionInfoSet Array of DevicePositionInfo 设备所在机架信息
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询设备所在机架

输入示例

https://bm.tencentcloudapi.com/?Action=DescribeDevicePosition
&Offset=0
&Limit=20
&VpcId=vpc-3c7b2102
&SubnetId=subnet-6igdzaix
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "DevicePositionInfoSet": [
            {
                "InstanceId": "tcpm-ewqcmo3n",
                "Zone": "ap-shanghai-bls-2",
                "VpcId": "vpc-3c7b2102",
                "SubnetId": "subnet-6igdzaix",
                "LanIp": "10.88.99.2",
                "Alias": "TMI-vpc跨az购买",
                "RckName": "0302-G03",
                "PosCode": 3,
                "SwitchName": "0302-G01-01/0302-G02-01",
                "DeliverTime": "2018-08-07 18:41:09",
                "Deadline": "2100-01-01 00:00:00"
            }
        ],
        "RequestId": "e324c7c7-7a6f-41e8-a629-f29f4bbe908c"
    }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
UnauthorizedOperation 未授权操作

如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >