接口功能介绍
获取vpc的子网列表
接口约束
传参规范
URI
GET /vfw/v2_firewall_subnet_list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| filterNotValid | 否 | Boolean | 过滤无效子网 | ||
| trafficSubnet | 是 | Boolean | 是否查询业务子网 | true | |
| vpcId | 是 | String | vpc id |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 请求地址类型 | CTAPI | |
| regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 错误码：CFW_0000 :成功!;CFW_0001:参数错误！;CFW_0002：业务错误！ | CFW_0000 | |
| returnObj | Object | 接口返回结果 | SubnetInfo |
表 SubnetInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| availabilityZones | Array of Strings | 子网所在的可用区名称 | ||
| availableIpCount | Integer | 子网内可用 IPv4 数目 | 1 | |
| cidr | String | 子网网段，掩码范围为 16-28 位 | ||
| createdAt | String | 创建时间 | ||
| description | String | 描述 | ||
| dnsList | Array of Strings | DNS 服务器地址:默认为空；必须为正确的 IPv4 格式；重新触发 DHCP 后生效，最大数组长度为 4 | ||
| end | String | 子网网段结束 IP | ||
| gatewayIp | String | 子网网关 | ||
| ipv6Cidr | String | 子网 Ipv6 网段，掩码范围为 16-28 位 | ||
| ipv6End | String | 子网内可用的结束 IPv6 地址 | ||
| ipv6GatewayIp | String | v6 网关地址 | ||
| ipv6Start | String | 子网内可用的起始 IPv6 地址 | ||
| name | String | 名称 | ||
| networkAclId | String | 子网 acl ID | ||
| ntpList | Array of Strings | NTP 服务器地址: 默认为空，必须为正确的域名或 IPv4 格式；重新触发 DHCP 后生效，最大数组长度为 4 | ||
| routeTableId | String | 子网路由表 ID | ||
| start | String | 子网网段起始 IP | ||
| subnetId | String | 子网ID | ||
| type | Integer | 子网类型 :当前仅支持：0（普通子网） | 0 | |
| updatedAt | String | 更新时间 | ||
| vpcId | String | VpcId |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "800",
"message": "成功！",
"returnObj": {
{
"subnetId": "subnet-kzgi24cga7",
"name": "subnet-osm",
"description": "",
"vpcID": "vpc-duuvhestyg",
"availabilityZones": [],
"routeTableId": "rtb-wzxzzc0wv9",
"cidr": "192.168.0.0/24",
"gatewayIp": "192.168.0.1",
"start": "192.168.0.3",
"end": "192.168.0.253",
"availableIpCount": 222,
"ipv6Cidr": "",
"ipv6Start": "",
"ipv6End": "",
"ipv6GatewayIp": "fe80::f816:3eff:fea2:63b4",
"dnsList": [
"114.114.114.114",
"8.8.8.8"
],
"ntpList": [],
"type": 0
},
{
"subnetId": "subnet-y18n9flj9k",
"name": "subnet-eip-eu9zv8xgev-vfw",
"description": "云防火墙引流专用-请勿删除",
"vpcID": "vpc-duuvhestyg",
"availabilityZones": [],
"routeTableId": "rtb-hagtbrq7io",
"cidr": "192.168.2.0/28",
"gatewayIp": "192.168.2.1",
"start": "192.168.2.3",
"end": "192.168.2.14",
"availableIpCount": 11,
"ipv6Cidr": "",
"ipv6Start": "",
"ipv6End": "",
"ipv6GatewayIp": "fe80::f816:3eff:fe4b:d2e6",
"dnsList": [
"100.95.0.1",
"fd00:ec2::250"
],
"ntpList": [],
"type": 0
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
