获取私有网络列表

最近更新时间：2023.07.03 16:32:37

首次发布时间：2022.02.25 18:58:31

本接口用于获取私有网络列表。

请求方法

GET

请求参数

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

名称	类型	是否必选	示例值	描述
Action	String	是	ListVPCInstances	公共参数。该参数表示接口名称。取值：ListVPCInstances。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
page	String	否	1	私有网络列表的页码。
limit	Integer	否	10	分页查询时设置的每页行数。
order_by	Integer	否	1	查询出来的私有网络的排列顺序，按照创建时间排序。取值范围： 1：按照降序排列。 2（默认值）：按照升序排列。
cluster_names	String	否	****-zzcu01	节点名称的列表。多个节点之间用半角逗号（,）分隔。
vpc_identity_list	String	否	vpc-sbjngs****	私有网络 ID 的列表。多个私有网络之间用半角逗号（,）分隔。
fuzzy_vpc_id_or_name	String	否	vpc	私有网络 ID 或者名称。支持模糊查询。
with_resource_statistic	Boolean	否	false	是否返回私有网络下的资源的统计数据。取值范围： true：返回资源的统计数据。 false：不返回资源的统计数据。

返回数据

名称	类型	示例值	描述
vpc_instances	[]VPCInstance	请参见返回示例	私有网络的列表。
count	String	1	私有网络的数量。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListVPCInstances&Version=2021-04-30
&<其他公共参数>

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2023052216422061A01DB40312EB9C****",
    "Action": "ListVPCInstances",
    "Version": "2021-04-30",
    "Service": "veenedge",
    "Region": "cn-north-1"
  },
  "Result": {
    "vpc_instances": [
      {
        "account_identity": 210000****,
        "user_identity": 0,
        "vpc_identity": "vpc-sbjngs****",
        "vpc_name": "郑州联通01-默认VPC",
        "vpc_ns": "ns-210000****",
        "cluster": {
          "cluster_name": "****-zzcu01",
          "country": "CN",
          "region": "CentralChina",
          "province": "HA",
          "city": "410100",
          "isp": "CUCC",
          "level": "2",
          "alias": "郑州联通01"
        },
        "status": "available",
        "is_default": true,
        "desc": "郑州联通01-默认VPC",
        "sub_nets": [
          {
            "account_identity": 210000****,
            "user_identity": 0,
            "subnet_identity": "subnet-kcpmjzfl4rl****",
            "cidr_ip": "172.**.**.64",
            "cidr_mask": 26,
            "create_time": 1632808736,
            "update_time": 1632808736
           }
         ],
         "create_time": 1632808736,
         "update_time": 1635757441
      }
    ]
    "count": 1
  }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。

请求方法

请求参数

返回数据

请求示例

返回示例

错误码

边缘计算节点

获取私有网络列表

请求方法

请求参数

返回数据

请求示例

返回示例

错误码