本接口用于查询经典网络的列表。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListClassicNetworks | 接口名称。当前 API 的名称为 ListClassicNetworks。 |
Version | String | 是 | 2021-04-30 | 接口版本。当前 API 的版本为 2021-04-30。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
network_ids | String[] | 否 | ["classic-mn5ljrh59bk****", "classic-sl5nrzbftb8*****"] | 经典网络 ID 的列表。 |
network_status | String[] | 否 | ["creating", "available"] | 经典网络状态的列表。取值范围:
|
cluster_names | String[] | 否 | ["nbct01"] | 节点名称的列表。 |
ipv4_cidr_blocks | String[] | 否 | ["10.0.0.0/8"] | IPv4 CIDR 网段的列表。 |
ipv6_cidr_blocks | String[] | 否 | ["2001:db8::/64"] | IPv6 CIDR 网段的列表。 |
network_types | String[] | 否 | ["default", "custom"] | 经典网络类型的列表。取值范围:
|
TagFilters | Object[] | 否 | - | 标签过滤器。 |
project | String | 否 | default | 经典网络所属的项目。 |
page_option | Object | 是 | - | 分页设置。 |
order_option | Object | 否 | - | 排序设置。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结果。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
networks | Object[] | - | 经典网络列表。 |
total_count | Long | 100 | 经典网络总数。 |
POST https://veenedge.volcengineapi.com/?Action=ListClassicNetworks&Version=2021-04-30 &<其他公共参数> { "cluster_names": [ "nbct01" ], "page_option": { "page_no": 1, "page_size": 10 } }
{ "ResponseMetadata": { "RequestId": "202605081141117ACEF0A3D67D286B****", "Action": "ListClassicNetworks", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" }, "Result": { "networks": [ { "account_id": 210000****, "cluster": { "alias": "宁波电信01", "city": "330200", "cluster_name": "nbct01", "country": "CN", "isp": "CTCC", "province": "ZJ", "region": "EastChina" }, "create_time": 1776235247, "ipv4_cidr_block": "172.16.0.0/12", "ipv6_cidr_block": "fdcb:aa9e:495d:4e1c::/64", "network_description": "", "network_id": "classic-mn5ljrh59b****", "network_name": "classic-eastchina-01", "network_status": "available", "network_type": "custom", "project": "default", "subnets": [ { "account_id": 210000****, "cluster": { "alias": "宁波电信01", "city": "330200", "cluster_name": "nbct01", "country": "CN", "isp": "CTCC", "province": "ZJ", "region": "EastChina" }, "create_time": 1776235247, "ipv4_cidr_block": "172.16.0.0/12", "ipv6_cidr_block": "fdcb:aa9e:495d:4e1c::/64", "network_info": { "network_id": "classic-mn5ljrh59bk****" }, "project": "default", "subnet_description": "测试经典网络", "subnet_id": "subnet-nkbcsp4d7x8****", "subnet_name": "subnet-eastchina-01", "subnet_status": "available", "update_time": 1776235248 } ], "update_time": 1776235248 } ], "total_count": 1 } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。