DescribeVpcs -

更新时间:
复制为 MD 格式

查询VPC

说明

目前该API接口已标记为弃用,推荐使用替代API:Vpc(2016-04-28) - DescribeVpcs

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:DescribeVpcs

get

*全部资源

*

  • vpc:tag

请求参数

名称

类型

必填

描述

示例值

VpcId

string

RegionId

string

IsDefault

boolean

PageNumber

integer

PageSize

integer

返回参数

名称

类型

描述

示例值

object

PageSize

integer

RequestId

string

PageNumber

integer

TotalCount

integer

Vpcs

object

Vpc

array<object>

array<object>

CreationTime

string

VpcName

string

Status

string

VpcId

string

VRouterId

string

IsDefault

boolean

CidrBlock

string

Description

string

RegionId

string

VSwitchIds

object

VSwitchId

array

string

UserCidrs

object

UserCidr

array

string

示例

正常返回示例

JSON格式

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "Vpcs": {
    "Vpc": [
      {
        "CreationTime": "",
        "VpcName": "",
        "Status": "",
        "VpcId": "",
        "VRouterId": "",
        "IsDefault": true,
        "CidrBlock": "",
        "Description": "",
        "RegionId": "",
        "VSwitchIds": {
          "VSwitchId": [
            ""
          ]
        },
        "UserCidrs": {
          "UserCidr": [
            ""
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidAliuid User Id is not valid.
400 InvalidResourceGroupId.NotFound The Specified ResourceGroupId not exists.
400 OperationUnsupported.ResourceGroupId %s
400 InvalidVpcIdNumber.NotSupported The number of vpcIds exceeds the limit.
400 InvalidTagKey The tag keys are not valid.
400 InvalidTagValue The tag values are not valid.
400 IellgalParameter.OwnerAccount The specified parameter OwnerAccount is not valid.
400 OperationFailed.Endpoint Operation failed because the RegionId is unavailable in this endpoint.
500 InternalError The request processing has failed due to some unknown error.
404 InvalidRegionId.NotFound The specified RegionId is not found. 指定的 RegionId 不存在,请您检查此产品在该地域是否可用。

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

变更历史

更多信息,参考变更详情