调用DescribeVpcs接口查询已创建的VPC。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeVpcs

要执行的操作,取值:DescribeVpcs

RegionId String cn-hangzhou

VPC所在的地域ID。

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

VpcId String vpc-bp1b1xjllp3ve5yze****

VPC的ID。

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

VpcName String Vpc-1

VPC的名称。

IsDefault Boolean false

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

  • true(默认值):查询指定地域下的所有VPC。
  • false:不查询默认VPC。
DryRun Boolean false

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

  • true:发送检查请求,不会查询资源状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回2xx HTTP状态码并直接查询资源状况。
ResourceGroupId String rg-acfmxvfvazb4p****

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

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 10

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

VpcOwnerId Long 12345678

VPC所属的账号ID。

DhcpOptionsSetId String dopt-o6w0df4epg9zo8isy****

DHCP选项集的ID。

返回数据

名称 类型 示例值 描述
Vpcs Array of Vpc

VPC的详细信息。

Vpc
CenStatus String Attached

VPC绑定云企业网的状态。

仅VPC绑定了云企业网时返回Attached

CidrBlock String 192.168.0.0/16

VPC的IPv4网段。

CreationTime String 2018-04-18T15:02:37Z

VPC的创建时间。

Description String This is my VPC.

VPC的描述信息。

DhcpOptionsSetId String dopt-o6w0df4epg9zo8isy****

DHCP选项集的ID。

DhcpOptionsSetStatus String Available

DHCP选项集的状态。

  • Available:可用。
  • InUse:使用中。
  • Deleted:已删除。
  • Pending:配置中。
Ipv6CidrBlock String 2408:XXXX:0:a600::/56

VPC的IPv6网段。

Ipv6CidrBlocks Array of Ipv6CidrBlock

VPC的IPv6网段信息。

Ipv6CidrBlock
Ipv6CidrBlock String 2408:XXXX:0:a600::/56

VPC的IPv6网段。

Ipv6Isp String BGP

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

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

是否是该地域的默认VPC。

  • true:是该地域的默认VPC。
  • false:不是该地域的默认VPC。
NatGatewayIds List nat-245xxxftwt45bg****

NAT网关的ID。

OwnerId Long 1234567

VPC所属的账号ID。

RegionId String cn-hangzhou

VPC所在的地域。

ResourceGroupId String rg-acfmxazb4ph****

VPC所属的资源组ID。

RouterTableIds List vtb-bp1krxxzp0c29fmon****

路由表ID。

SecondaryCidrBlocks List 192.168.20.0/24

VPC的附加IPv4网段。

Status String Available

VPC的状态,取值:

  • Pending:配置中。
  • Available:可用。
Tags Array of Tag

VPC的标签信息。

Tag
Key String env

VPC绑定的标签键。

Value String internal

VPC绑定的标签值。

UserCidrs List 10.0.0.0/8

用户侧网段的列表。

VRouterId String vrt-bp1jcg5cmxjbl9xgc****

VPC路由器的ID。

VSwitchIds List vsw-bp1nhbnpv2blyz8dl****

VPC中交换机的列表。

VpcId String vpc-bp1qpo0kug3a20qqe****

VPC的ID。

VpcName String vpc1

VPC的名称。

TotalCount Integer 2

列表条目数。

PageNumber Integer 1

当前页码。

PageSize Integer 10

每页包含的条目数。

RequestId String C6532AA8-D0F7-497F-A8EE-094126D441F5

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpcs
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
500 InternalError The request processing has failed due to some unknown error. 请求处理由于某些未知错误失败。
400 InvalidResourceGroupId The specified ResourceGroupId does not exist. 资源组ID不存在。

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