文档

GetUserVpcs - 获取VPC列表

更新时间:

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pts:GetUserVpcsRead
  • acs:pts::{#accountId}:*

请求参数

名称类型必填描述示例值
PageNumberinteger

分页查询时设置的页码。

1
PageSizeinteger

每页显示记录条数。

1
RegionIdstring

地域 ID。

cn-hangzhou
VpcIdstring

专有网络 ID。

vpc-2ze22asdfuwiea2ebjkqhf4pyj

返回参数

名称类型描述示例值
object
TotalCountlong

总条数。

100
Vpcsobject []

VPC 列表。

VpcIdstring

专有网络 ID。

vpc-uf6gc56wdjpafoiwej6adqb4qn72xtw
RegionIdstring

地域 ID。

cn-hangzhou
VpcNamestring

VPC 名称。

shanghai-vpc
CidrBlockstring

VPC 的 IPv4 网段。

172.16.80.0/20
Descriptionstring

VPC 的描述信息。

ResourceGroupIdstring

VPC 所属的资源组 ID。

rg-acfm3fzmgkehpewjertna
VSwitchIdsarray

交换机列表。

string

交换机 ID。

vsw-bp1s21fe8r3esdslplvcv5240
RouterTableIdsarray

路由表 ID 列表。

string

路由表 ID。

vtb-bp11tkmteho3svealseipea6h
RequestIdstring

请求 ID。

CEE46204-E1CF-5F48-B094-67362DD4B73F
Messagestring

错误提示信息,若成功则为空。

PageSizeinteger

每页显示记录条数。

10
PageNumberinteger

分页查询时设置的页码。

1
HttpStatusCodeinteger

HTTP 状态码。

200
Codestring

系统状态码。

200
Successboolean

是否成功。

  • true:成功
  • false:失败
true

示例

正常返回示例

JSON格式

{
  "TotalCount": 100,
  "Vpcs": [
    {
      "VpcId": "vpc-uf6gc56wdjpafoiwej6adqb4qn72xtw",
      "RegionId": "cn-hangzhou",
      "VpcName": "shanghai-vpc",
      "CidrBlock": "172.16.80.0/20",
      "Description": "空",
      "ResourceGroupId": "rg-acfm3fzmgkehpewjertna",
      "VSwitchIds": [
        "vsw-bp1s21fe8r3esdslplvcv5240"
      ],
      "RouterTableIds": [
        "vtb-bp11tkmteho3svealseipea6h"
      ]
    }
  ],
  "RequestId": "CEE46204-E1CF-5F48-B094-67362DD4B73F",
  "Message": "空",
  "PageSize": 10,
  "PageNumber": 1,
  "HttpStatusCode": 200,
  "Code": "200",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
403CodeThe specified parameter is invalid.输入参数有误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
2022-04-12OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
出参OpenAPI 返回结构发生变更
2022-04-12新增 OpenAPI看变更集
  • 本页导读 (1)