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

文档中心

立即注册

导航

TrafficRoute DNS 套件

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

最近更新时间：2025.05.22 20:07:51首次发布时间：2023.06.26 20:59:38

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

使用说明

请求频率：每秒最多调用 10 次。

注意事项

符合以下要求的火山引擎账号才有权限调用本 API：

对于通过火山引擎企业组织服务添加的授权，仅企业组织服务的管理员账号有权限调用本 API。
对于通过验证码添加的授权，仅使用了验证码为其他火山引擎账号添加授权的火山引擎账号有权限调用本 API。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListUserVPC	要执行的操作，取值：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。

返回参数

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

参数	类型	示例值	描述
VPCs	Array of Object	无	指定账号的 VPC 列表。
PageNumber	Integer	1	页码。
PageSize	Integer	10	每页包含的 VPC 的数量。
Total	Integer	10	总数

请求示例

GET https://private-zone.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
      	
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
400	ErrRegionNotSupport	%s of [%s] not supported by private_zone	private_zone不支持[%s]地域的%s
500	ErrInternalServer	server internal error	服务内部错误