1. 接口描述
接口请求域名: bmvpc.tencentcloudapi.com 。
托管可以加入物理机子网,虚拟子网,DOCKER子网,通过此接口可以查询托管加入的子网。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSubnetByHostedDevice。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 托管机器ID, 如chm-xasdfx2j |
Types.N | 否 | Array of Integer | 子网类型。0: 物理机子网; 7: DOCKER子网 8: 虚拟子网 |
Offset | 否 | Integer | 查询的起始位置。 |
Limit | 否 | Integer | 查询的个数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 子网个数 |
Data | Array of SubnetInfo | 子网列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeSubnetByHostedDevice
输入示例
https://bmvpc.tencentcloudapi.com/?Action=DescribeSubnetByHostedDevice
&InstanceId=chm-5im64oip
&Offset=2
&Limit=3
&Types.=7
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 16,
"Data": [
{
"VpcId": "vpc-13uonit1",
"VpcName": "mogujie-??",
"VpcCidrBlock": "10.50.128.0/17",
"SubnetId": "subnet-f5lsmjdu",
"SubnetName": "kvm-net-2183",
"CidrBlock": "10.50.183.0/24",
"Type": 0,
"ZoneId": 1000400001,
"CpmNum": 0,
"VlanId": 2183,
"DistributedFlag": 1,
"DhcpEnable": 1,
"DhcpServerIp": [
"10.50.183.11"
],
"IpReserve": 1,
"AvailableIpNum": 0,
"TotalIpNum": 0,
"SubnetCreateTime": "2017-11-20 10:34:00"
},
{
"VpcId": "vpc-13uonit1",
"VpcName": "mogujie-??",
"VpcCidrBlock": "10.50.128.0/17",
"SubnetId": "subnet-p7mczxs4",
"SubnetName": "kvm-net-2184",
"CidrBlock": "10.50.184.0/24",
"Type": 0,
"ZoneId": 1000400001,
"CpmNum": 0,
"VlanId": 2184,
"DistributedFlag": 1,
"DhcpEnable": 1,
"DhcpServerIp": [
"10.50.184.11"
],
"IpReserve": 1,
"AvailableIpNum": 0,
"TotalIpNum": 0,
"SubnetCreateTime": "2017-11-20 10:39:52"
},
{
"VpcId": "vpc-13uonit1",
"VpcName": "mogujie-??",
"VpcCidrBlock": "10.50.128.0/17",
"SubnetId": "subnet-69x7na3y",
"SubnetName": "kvm-net-2185",
"CidrBlock": "10.50.185.0/24",
"Type": 0,
"ZoneId": 1000400001,
"CpmNum": 0,
"VlanId": 2185,
"DistributedFlag": 1,
"DhcpEnable": 1,
"DhcpServerIp": [
"10.50.185.11"
],
"IpReserve": 1,
"AvailableIpNum": 0,
"TotalIpNum": 0,
"SubnetCreateTime": "2017-11-20 10:39:53"
}
],
"RequestId": "25465fbf-df82-417e-9d75-040e7b76f479"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |