接口功能介绍
查询用户专有网络 VPC 下子网详情。
接口约束
无。
URI
GET /v4/vpc/query-subnet
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 否 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | |
| regionID | String | 是 | 资源池 ID | |
| projectID | String | 否 | 企业项目 ID，默认为"0" | |
| subnetID | String | 是 | subnet 的 ID | subnet-oqu48f4a3l |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 |
| message | String | statusCode 为 900 时的错误信息, 英文 | |
| description | String | statusCode 为 900 时的错误信息，中文 | |
| returnObj | object | 接口业务数据 | |
| errorCode | String | 业务细分错误码，三段式：product.module.code |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| subnetID | String | subnet ID | subnet-han72lo303 |
| name | String | 名称 | subNet-yuioef8mp |
| description | String | 描述 | subNet |
| vpcID | String | VpcID | vpc-hfw53u96ku |
| availabilityZones | array | 子网所在的可用区名称 | ["az1", "az2"] |
| routeTableID | String | 子网路由表 ID | rtb-fie3qauij5 |
| networkAclID | String | 子网 acl ID | |
| CIDR | String | 子网网段，掩码范围为 16-28 位 | 192.168.0.0/24 |
| gatewayIP | String | 子网网关 | 192.168.0.1 |
| start | String | 子网网段起始 IP | 192.168.0.3 |
| end | String | 子网网段结束 IP | 192.168.0.253 |
| availableIPCount | Integer | 子网内可用 IPv4 数目 | 251 |
| ipv6Enabled | Integer | 是否配置了ipv6网段 | |
| ipv6CIDR | String | 子网 Ipv6 网段，掩码范围为 16-28 位 | 2408:4002:10c4:4e03::/64 |
| ipv6Start | String | 子网内可用的起始 IPv6 地址 | 2408:4002:10c4:4e03:cb82 |
| ipv6End | String | 子网内可用的结束 IPv6 地址 | 2408:4002:10c4:4e03:cb11 |
| ipv6GatewayIP | String | v6 网关地址 | fe80::f816:3eff:fe2b:cb82 |
| dnsList | String of Array | DNS 服务器地址:默认为空；必须为正确的 IPv4 格式；重新触发 DHCP 后生效，最大数组长度为 4 | ["114.114.114.114","8.8.8.8"] |
| ntpList | String of Array | NTP 服务器地址: 默认为空，必须为正确的域名或 IPv4 格式；重新触发 DHCP 后生效，最大数组长度为 4 | |
| type | Integer | 子网类型 :当前仅支持：0（普通子网） | 0 |
| createdAt | String | 创建时间 | 2022-09-02T06:54:45Z |
| updatedAt | String | 更新时间 | 2022-09-02T06:54:45Z |
请求示例
GET /v4/vpc/query-subnet?regionID=bb9fdb42056f11eda1610242ac110002&subnetID=subnet-han72lo303
响应示例
{
"statusCode":800,
"errCode":"SUCCESS",
"message":"success",
"descritption": "",
"returnObj":{
"subnetID": "subnet-han72lo303",
"name": "subNet-yuioef8mp",
"description": "subNet",
"vpcID": "vpc-hfw53u96ku",
"availabilityZones": ["az1", "az2"],
"routeTableID": "rtb-fie3qauij5",
"networkAclID": "",
"CIDR": "192.168.0.0/24",
"gateway": "192.168.0.1",
"start": "192.168.0.3",
"end": "192.168.0.253",
"availableIpCount": 251,
"ipv6CIDR": "fe80::f816:3eff:fe2b:cb82",
"ipv6Start": "2408:4002:10c4:4e03:cb82",
"ipv6End": "2408:4002:10c4:4e03:cb11",
"ipv6GatewayIP": "fe80::f816:3eff:fe2b:cb82",
"dnsList": ["114.114.114.114", "8.8.8.8"],
"ntpList": [],
"type": 0,
"createdAt": "2022-09-02T06:54:45Z",
"updatedAt": "2022-09-02T06:54:45Z"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
