文档

DescribeVpcs - 查询已创建的VPC

更新时间:

查询已创建的VPC。

调试

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

授权信息

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

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

请求参数

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

VPC 的 ID。

最多支持指定 20 个 VPC ID,多个 VPC 的 ID 之间用半角逗号(,)隔开。

vpc-bp1b1xjllp3ve5yze****
RegionIdstring

VPC 所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
VpcNamestring

VPC 的名称。

Vpc-1
IsDefaultboolean

是否查询指定地域下的默认 VPC,取值:

  • true(默认值):查询指定地域下的默认 VPC。

  • false:不查询默认 VPC。

false
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接查询资源状况。

false
ResourceGroupIdstring

要查询的 VPC 所属的资源组 ID。

rg-acfmxvfvazb4p****
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

10
VpcOwnerIdlong

VPC 所属的阿里云账号 ID。

253460731706911258
DhcpOptionsSetIdstring

DHCP 选项集的 ID。

dopt-o6w0df4epg9zo8isy****
EnableIpv6boolean

是否查询指定地域下开启 IPv6 网段的 VPC,默认为空值(空值则不根据是否开启 IPv6 网段做过滤),取值:

  • false:不开启。
  • true:开启。
false
Tagobject []

资源的标签。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

返回的信息。

PageSizeinteger

分页查询时每页的行数。

10
RequestIdstring

请求 ID。

C6532AA8-D0F7-497F-A8EE-094126D441F5
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

2
Vpcsobject []

VPC 的详细信息。

CreationTimestring

VPC 的创建时间。

2021-04-18T15:02:37Z
Statusstring

VPC 的状态,取值:

  • Pending:配置中。

  • Available:可用。

Available
VpcIdstring

VPC 的 ID。

vpc-bp1qpo0kug3a20qqe****
IsDefaultboolean

是否是该地域的默认 VPC。取值:

  • true:是该地域的默认 VPC。

  • false:不是该地域的默认 VPC。

false
OwnerIdlong

VPC 所属的阿里云账号 ID。

253460731706911258
RegionIdstring

VPC 所在的地域 ID。

cn-hangzhou
VpcNamestring

VPC 的名称。

vpc1
VRouterIdstring

VPC 路由器的 ID。

vrt-bp1jcg5cmxjbl9xgc****
DhcpOptionsSetStatusstring

DHCP 选项集的状态。取值:

  • Available:可用。

  • InUse:使用中。

  • Deleted:已删除。

  • Pending:配置中。

Available
CidrBlockstring

VPC 的 IPv4 网段。

192.168.0.0/16
Descriptionstring

VPC 的描述信息。

This is my VPC.
ResourceGroupIdstring

VPC 所属的资源组 ID。

rg-acfmxazb4ph****
DhcpOptionsSetIdstring

DHCP 选项集的 ID。

dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlockstring

VPC 的 IPv6 网段。

2408:XXXX:0:a600::/56
CenStatusstring

VPC 绑定云企业网的状态。 仅 VPC 绑定了云企业网时返回 Attached

Attached
Tagsobject []

VPC 的标签信息。

Keystring

VPC 绑定的标签键。

FinanceDept
Valuestring

VPC 绑定的标签值。

FinanceJoshua
Ipv6CidrBlocksobject []

VPC 的 IPv6 网段信息。

Ipv6Ispstring

VPC 的 IPv6 地址段类型,取值:

  • BGP:阿里云 BGP IPv6。
  • ChinaMobile:中国移动(单线)。
  • ChinaUnicom:中国联通(单线)。
  • ChinaTelecom:中国电信(单线)。
说明 如果是开通了单线带宽白名单的用户,该字段可以设置为 ChinaTelecom(中国电信)、ChinaUnicom(中国联通)和 ChinaMobile(中国移动)。
BGP
Ipv6CidrBlockstring

VPC 的 IPv6 网段。

2408:XXXX:0:a600::/56
VSwitchIdsarray

查询到的 VPC 中交换机的列表信息。

最多可以查询到 VPC 中最近创建的 300 个交换机的信息。如果您需要查询 VPC 中全部交换机的信息,可以执行 DescribeVSwitches 接口查询。

string

查询到的 VPC 中交换机的列表信息。

最多可以查询到 VPC 中最近创建的 300 个交换机的信息。如果您需要查询 VPC 中全部交换机的信息,可以执行 DescribeVSwitches 接口查询。

vsw-bp1nhbnpv2blyz8dl****
SecondaryCidrBlocksarray

附加网段信息。

string

VPC 的附加网段。

192.168.20.0/24
UserCidrsarray

用户侧网段的列表。

string

用户侧网段的列表。

10.0.0.0/8
NatGatewayIdsarray

NAT 网关的 ID。

string

NAT 网关的 ID。

nat-245xxxftwt45bg****
RouterTableIdsarray

路由表信息。

string

路由表 ID。

vtb-bp1krxxzp0c29fmon****
EnabledIpv6boolean

是否开启 IPv6。

枚举值:
  • falsefalse
  • truetrue
false

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "C6532AA8-D0F7-497F-A8EE-094126D441F5",
  "PageNumber": 1,
  "TotalCount": 2,
  "Vpcs": {
    "Vpc": [
      {
        "CreationTime": "2021-04-18T15:02:37Z",
        "Status": "Available",
        "VpcId": "vpc-bp1qpo0kug3a20qqe****",
        "IsDefault": false,
        "OwnerId": 253460731706911260,
        "RegionId": "cn-hangzhou",
        "VpcName": "vpc1",
        "VRouterId": "vrt-bp1jcg5cmxjbl9xgc****",
        "DhcpOptionsSetStatus": "Available",
        "CidrBlock": "192.168.0.0/16",
        "Description": "This is my VPC.",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
        "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
        "CenStatus": "Attached",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "Ipv6CidrBlocks": {
          "Ipv6CidrBlock": [
            {
              "Ipv6Isp": "BGP",
              "Ipv6CidrBlock": "2408:XXXX:0:a600::/56"
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp1nhbnpv2blyz8dl****"
          ]
        },
        "SecondaryCidrBlocks": {
          "SecondaryCidrBlock": [
            "192.168.20.0/24"
          ]
        },
        "UserCidrs": {
          "UserCidr": [
            "10.0.0.0/8"
          ]
        },
        "NatGatewayIds": {
          "NatGatewayIds": [
            "nat-245xxxftwt45bg****"
          ]
        },
        "RouterTableIds": {
          "RouterTableIds": [
            "vtb-bp1krxxzp0c29fmon****"
          ]
        },
        "EnabledIpv6": false
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidVpcIdNumber.NotSupportedThe number of vpcIds exceeds the limit.vpcId数量超出限制
400InvalidAliuidUser Id is not valid.-
400InvalidResourceGroupIdThe specified ResourceGroupId does not exist.资源组ID不存在。
400InvalidTagKeyThe tag keys are not valid.无效的标签索引
400InvalidTagValueThe tag values are not valid.无效的标签值
400InvalidResourceGroupId.NotFoundThe Specified ResourceGroupId not exists.-
400OperationUnsupported.ResourceGroupId%s-
400IellgalParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.-
400IllegalParam.OwnerIdThe specified parameter VpcOwnerId is not valid.-
400InvalidAccount.NotFoundThe account is invalid.操作失败,使用了无效的调用账号。
500InternalErrorThe request processing has failed due to some unknown error.请求处理由于某些未知错误失败。

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

变更历史

变更时间变更内容概要操作
2024-05-16OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:EnableIpv6
2024-04-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-07-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
2023-07-26OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:Tag
2023-06-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:500
  • 本页导读 (1)