ListUserVPC-获取一个账号的 VPC 列表--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListUserVPC-获取一个账号的 VPC 列表

最近更新时间：2024.08.12 11:00:22首次发布时间：2023.06.26 20:59:38

获取一个火山引擎账号的 VPC 列表。

说明

只有火山引擎企业组织服务的管理员账号才能调用本 API。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListUserVPC?Version=2022-06-01

请求参数

除了以下参数，您还需要对请求进行鉴权。

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`ListUserVPC`	API 的名称。该参数的取值是 `ListUserVPC`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。
AccountID	String	是	`210xxxxx`	火山引擎账号。
Region	String	是	`cn-beijing`	VPC 所在的地域。
PageNumber	Integer	否	`1`	页码。页数由获取的 VPC 总数和 `PageSize` 确定。默认为 1。
PageSize	Integer	否	`20`	每页包含的 VPC 的数量。默认为 20，最大不能超过 100。

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在地域。

Result 对象

名称	类型	描述
VPCs	Array of Objects	指定账号的 VPC 列表。
PageNumber	Integer	页码。
PageSize	Integer	每页包含的 VPC 的数量。

示例

请求示例

GET https://open.volcengineapi.com/?Action=ListUserVPC&Version=2022-06-01&AccountID=12345&Region=cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221214140553EC822FFD341E9C19EF59",
        "Action": "ListUserVPC",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "VPCs": [
              {
                 "ID": "vpc-ahdxxxcd",
                 "Name": "test"
              }    
         ],
         "PageNumber": 1,
         "PageSize": 20
      	
    }
}

错误码

您可访问公共错误码，获取详细信息。