本接口用于获取一个私有网络下的子网的列表。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListSubnetInstances | 接口名称。当前 API 的名称为 ListSubnetInstances 。 |
Version | String | 是 | 2021-04-30 | 接口版本。当前 API 的版本为 2021-04-30 。 |
subnet_identity_list | []String | 否 | subnet-sl7jpnt69tr**** | 子网的 ID 的列表。ID 之间用半角逗号(,)分隔。 |
status_list | []String | 否 |
| 子网的状态的列表。子网状态之间用半角逗号(,)分隔。取值范围:
|
fuzzy_subnet_id | String | 否 | z46wp | 子网的 ID。支持模糊查询。 |
fuzzy_name | String | 否 | subnet-dev | 子网的名称。支持模糊查询。 |
fuzzy_vpc_id | String | 否 | nx5r | 私有网络的 ID。支持模糊查询。 |
fuzzy_cidr_ip | String | 否 | 172.**.**.0 | 子网的 IP 地址。支持模糊查询。 |
cluster_names | []String | 否 | **ct05 | 子网所属的节点的列表。节点之间用半角逗号(,)分隔。 |
page | Integer | 否 |
| 子网列表的页码。 |
limit | Integer | 否 |
| 分页查询时设置的每页行数。 |
order_by | Integer | 否 |
| 查询出来的子网的排列顺序,按照创建时间排序。取值范围:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
subnet_instances | []SubnetInstances | 请参见返回示例 | 子网的信息。 |
count | Long | 2 | 子网的数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
subnet_identity | String | subnet-sl7jpnt69tr**** | 子网 ID。 |
cidr_ip | String | 172.**.**.128 | IP 地址。 |
cidr_mask | Integer | 26 | 前缀长度。 |
name | String | subnet-dev | 子网的名称。 |
desc | String | dev01 | 子网的描述。 |
status | String |
| 子网的状态:
|
vpc_info | VpcInfo | 请参见返回示例 | 子网所属的私有网络的信息。 |
create_time | Long | 1675062289 | 子网的创建时间。 |
update_time | Long | 1675062289 | 子网的更新时间。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
vpc_identity | String | vpc-7fs74n**** | 私有网络的 ID。 |
vpc_name | String | ****03-默认VPC | 私有网络的名称。 |
cluster | Cluster | 请参见返回示例 | 私有网络所属的节点的信息。 |
is_custom | Boolean |
| 是否是自定义私有网络:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
cluster_name | String | **ct05 | 节点的名称。 |
country | String | CN | 国家。 |
region | String | EastChina | 区域。 |
province | String | ZJ | 省份。 |
city | String | 330200 | 城市。 |
isp | String | CTCC | 运营商。 |
level | String |
| 节点的计费类别:
|
alias | String | 浙江**电信05 | 节点的中文名称。 |
GET https://veenedge.volcengineapi.com/?Action=ListSubnetInstances&Version=2021-04-30 &status_list=available &fuzzy_name=subnet-dev &<其他公共参数>
{ "ResponseMetadata": { "RequestId": "202403261747580BFCF572C919803F****", "Action": "ListSubnetInstances", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" }, "Result": { "subnet_instances": [ { "account_identity": 21000****, "user_identity": 0, "subnet_identity": "subnet-h4bl7d928g9****", "cidr_ip": "192.**.**.0", "cidr_mask": 24, "name": "subnet-dev01", "desc": "", "status": "available", "vpc_info": { "vpc_identity": "vpc-hk6lc2****", "vpc_name": "test-y", "cluster": { "cluster_name": "**ct02", "country": "CN", "region": "Northeast", "province": "JL", "city": "220100", "isp": "CTCC", "level": "2", "alias": "**电信02" }, "is_custom": true }, "create_time": 1700969987, "update_time": 1700969987 }, { "account_identity": 21000****, "user_identity": 0, "subnet_identity": "subnet-cl4q2cp7q6****", "cidr_ip": "10.**.**.0", "cidr_mask": 16, "name": "subnet-dev02", "desc": "", "status": "available", "vpc_info": { "vpc_identity": "vpc-vqmn7g****", "vpc_name": "vpc-test", "cluster": { "cluster_name": "**cm05", "country": "CN", "region": "EastChina", "province": "ZJ", "city": "330300", "isp": "CMCC", "level": "3", "alias": "**移动05" }, "is_custom": true }, "create_time": 1707362050, "update_time": 1707362050 }, { "account_identity": 210006****, "user_identity": 0, "subnet_identity": "subnet-b8h28fnz9****", "cidr_ip": "10.**.**.0", "cidr_mask": 16, "name": "subnet_dev03", "desc": "", "status": "available", "vpc_info": { "vpc_identity": "vpc-twqb9w****", "vpc_name": "vpc_dev", "cluster": { "cluster_name": "**cm03", "country": "CN", "region": "EastChina", "province": "ZJ", "city": "330100", "isp": "CMCC", "level": "2", "alias": "**移动03" }, "is_custom": true }, "create_time": 1709818244, "update_time": 1709818244 } ], "count": 3 } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。