获取子网列表--边缘计算节点-火山引擎

文档中心

立即注册

边缘计算节点

子网

获取子网列表

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
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[]	否	`available`	子网的状态的列表。子网状态之间用半角逗号（,）分隔。取值范围： available：可用。 modifying：变更中。 deleting：删除中。如果不指定该参数，系统将查询所有状态的子网。
cluster_names	String[]	否	`**ct05`	子网所属的节点的列表。节点之间用半角逗号（,）分隔。
projects	String[]	否	`default`	项目列表。项目之间用半角逗号（,）分隔。
TagFilters.N.Key	String[]	否	`env`	标签键。
TagFilters.N.Values.N	String[]	否	`prod`	标签值列表。
with_tag_info	Boolean	否	`false`	是否返回标签信息。取值范围： true：返回子网的标签信息。 false（默认值）：不返回子网的标签信息。
page	Integer	否	`1`	子网列表的页码。默认值：1。
limit	Integer	否	`10`	分页查询时设置的每页行数。默认值：1000。
order_by	Integer	否	`1`	查询出来的子网的排列顺序，按照创建时间排序。取值范围： 1（默认值）：按照降序排列。 2：按照升序排列。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结果。

参数	类型	示例值	描述
subnet_instances	Object[]	`-`	子网的信息。
count	Integer	`2`	子网的数量。

请求示例

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 请求失败。关于错误码的更多信息，参见错误码。

最近更新时间：2026.01.07 16:45:00

这个页面对您有帮助吗？

有用

无用

边缘计算节点

请求说明 #

请求参数 #

Query #

返回参数 #

请求示例 #

返回示例 #