You need to enable JavaScript to run this app.
导航
获取子网列表
最近更新时间:2024.07.18 11:03:32首次发布时间:2024.07.02 18:00:51

本接口用于获取一个私有网络下的子网的列表。

请求说明

  • 请求方式:GET
  • 请求地址:https://veenedge.volcengineapi.com/?Action=ListSubnetInstances&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

Query

参数类型是否必选示例值描述
ActionStringListSubnetInstances接口名称。当前 API 的名称为 ListSubnetInstances
VersionString2021-04-30接口版本。当前 API 的版本为 2021-04-30
subnet_identity_list[]Stringsubnet-sl7jpnt69tr****子网的 ID 的列表。ID 之间用半角逗号(,)分隔。

status_list

[]String

available

子网的状态的列表。子网状态之间用半角逗号(,)分隔。取值范围:

  • available:可用。
  • modifying:变更中。
  • deleting:删除中。
    如果不指定该参数,系统将查询所有状态的子网。
fuzzy_subnet_idStringz46wp子网的 ID。支持模糊查询。
fuzzy_nameStringsubnet-dev子网的名称。支持模糊查询。
fuzzy_vpc_idStringnx5r私有网络的 ID。支持模糊查询。
fuzzy_cidr_ipString172.**.**.0子网的 IP 地址。支持模糊查询。
cluster_names[]String**ct05子网所属的节点的列表。节点之间用半角逗号(,)分隔。

page

Integer

1

子网列表的页码。
如果 page 和 limit 参数都不指定,将返回全量数据;如果仅指定 limit,不指定 page ,将返回第 1 页数据;如果仅指定 page,不指定 limit,将返回全量数据;如果 page 和 limit 都指定,将返回符合条件的数据。

limit

Integer

10

分页查询时设置的每页行数。
如果 page 和 limit 参数都不指定,将返回全量数据;如果仅指定 limit,不指定 page ,将返回第 1 页数据;如果仅指定 page,不指定 limit,将返回全量数据;如果 page 和 limit 都指定,将返回符合条件的数据。

order_by

Integer

1

查询出来的子网的排列顺序,按照创建时间排序。取值范围:

  • 1(默认值):按照降序排列。
  • 2:按照升序排列。

返回参数

参数类型示例值描述
subnet_instances[]SubnetInstances请参见返回示例子网的信息。
countLong2子网的数量。

SubnetInstances

参数类型示例值描述
subnet_identityStringsubnet-sl7jpnt69tr****子网 ID。
cidr_ipString172.**.**.128IP 地址。
cidr_maskInteger26前缀长度。
nameStringsubnet-dev子网的名称。
descStringdev01子网的描述。

status

String

available

子网的状态:

  • available:可用。
  • modifying:变更中。
  • deleting:删除中。
vpc_infoVpcInfo请参见返回示例子网所属的私有网络的信息。
create_timeLong1675062289子网的创建时间。
update_timeLong1675062289子网的更新时间。

VpcInfo

参数类型示例值描述
vpc_identityStringvpc-7fs74n****私有网络的 ID。
vpc_nameString****03-默认VPC私有网络的名称。
clusterCluster请参见返回示例私有网络所属的节点的信息。

is_custom

Boolean

true

是否是自定义私有网络:

  • true:自定义私有网络。
  • false:非自定义私有网络。

Cluster

参数类型示例值描述
cluster_nameString**ct05节点的名称。
countryStringCN国家。
regionStringEastChina区域。
provinceStringZJ省份。
cityString330200城市。
ispStringCTCC运营商。

level

String

2

节点的计费类别:

  • 1:北上广
  • 2:地区中心
  • 3:一般城市
aliasString浙江**电信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 请求失败。关于错误码的更多信息,参见错误码