调用DescribeVpcAttribute接口查询指定VPC的配置信息。

调试

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

请求参数

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

系统规定参数。取值：DescribeVpcAttribute。

VpcId String 是 vpc-bp18sth14qii3pnv****

要查询的VPC的ID。
RegionId String 是 cn-hangzhou

VPC所属的地域ID。

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

DryRun Boolean 否 false

是否只预检此次请求。取值：

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

是否为默认VPC，取值：

  • false（默认值）：不是默认VPC。
  • true：是默认VPC。

返回数据

名称 类型 示例值 描述
CreationTime String 2021-10-16T07:31:09Z

VPC的创建时间。
Status String Available

VPC的状态。取值：

  • Available：可用。
  • Pending：配置中。
VpcId String vpc-bp18sth14qii3pnvo****

VPC的ID。
IsDefault Boolean false

是否是默认VPC。取值：

  • true：是默认VPC。
  • false（默认值）：非默认VPC。
ClassicLinkEnabled Boolean false

是否开启了ClassicLink功能。取值：

  • true：已开启。
  • false（默认值）：未开启。
OwnerId Long 283117732402483989

VPC所属的账号ID。
RegionId String cn-hangzhou

VPC所在的地域ID。
VpcName String doctest2

VPC的名称。
VRouterId String vrt-bp1jso6ng1at0ajsc****

VPC的路由器ID。
DhcpOptionsSetStatus String Available

DHCP选项集的状态。取值：

  • Available：可用。
  • InUse：使用中。
  • Deleted：已删除。
  • Pending：配置中。
CidrBlock String 192.168.0.0/16

VPC的IPv4网段。
RequestId String 7486AE4A-129D-43DB-A714-2432C074BA04

请求ID。
Description String VPC

VPC的描述。
ResourceGroupId String rg-acfmxazbvgb4ph****

资源组ID。
DhcpOptionsSetId String dopt-o6w0df4epg9zo8isy****

DHCP选项集的ID。
Ipv6CidrBlock String 2408:XXXX:0:a600::/56

VPC的IPv6网段。
VSwitchIds Array of String {"VSwitchId": [ "vsw-bp14cagpfysr29feg****" ]}

VPC下的交换机列表。
UserCidrs Array of String 172.16.0.1/24

用户侧网络的网段，如定义了多个网段，返回时会以半角逗号（,）隔开，最多支持3个网段。
SecondaryCidrBlocks Array of String 192.168.0.0/16

VPC附加IPv4网段。
AssociatedCens Array of AssociatedCen

绑定的云企业网列表。

如果VPC未绑定云企业网，则不返回该参数。
AssociatedCen
CenOwnerId Long 283117732402483989

云企业网所属账号的ID。
CenId String cen-7qthudw0ll6jmc****

VPC绑定的云企业网实例ID。
CenStatus String Attached

VPC绑定云企业网的状态。

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

CloudResources Array of CloudResourceSetType

VPC下的资源列表。
CloudResourceSetType
ResourceCount Integer 1

VPC下的资源数量。
ResourceType String VSwitch

VPC下的资源类型。取值：

  • VSwitch：交换机。
  • VRouter：路由器。
  • RouteTable：路由表。
Ipv6CidrBlocks Array of Ipv6CidrBlock

VPC的IPv6网段信息。
Ipv6CidrBlock
Ipv6Isp String BGP

VPC的IPv6地址段类型。取值：

  • BGP（默认值）：阿里云BGP IPv6。
  • ChinaMobile：中国移动（单线）。
  • ChinaUnicom：中国联通（单线）。
  • ChinaTelecom：中国电信（单线）。
说明 如果是开通了单线带宽白名单的用户，该字段可以设置为ChinaTelecom（中国电信）、ChinaUnicom（中国联通）和ChinaMobile（中国移动）。
Ipv6CidrBlock String 2408:XXXX:0:6a::/56

VPC的IPv6网段。
SupportIpv4Gateway Boolean true

是否支持IPv4网关。

  • true：是。
  • false：否。
Ipv4GatewayId String ipv4gw-5tsnc6s4ogsedtp3k****

IPv4网关的实例ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpcAttribute
&ResourceOwnerId=283117732402483989
&VpcId=vpc-bp18sth14qii3pnv****
&RegionId=cn-hangzhou
&DryRun=false
&IsDefault=false
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVpcAttributeResponse>
    <CreationTime>2021-10-16T07:31:09Z</CreationTime>
    <Status>Available</Status>
    <VpcId>vpc-bp18sth14qii3pnvo****</VpcId>
    <IsDefault>false</IsDefault>
    <ClassicLinkEnabled>false</ClassicLinkEnabled>
    <OwnerId>283117732402484000</OwnerId>
    <RegionId>cn-hangzhou</RegionId>
    <VpcName>doctest2</VpcName>
    <VRouterId>vrt-bp1jso6ng1at0ajsc****</VRouterId>
    <DhcpOptionsSetStatus>Available</DhcpOptionsSetStatus>
    <CidrBlock>192.168.0.0/16</CidrBlock>
    <RequestId>7486AE4A-129D-43DB-A714-2432C074BA04</RequestId>
    <Description>VPC</Description>
    <ResourceGroupId>rg-acfmxazbvgb4ph****</ResourceGroupId>
    <DhcpOptionsSetId>dopt-o6w0df4epg9zo8isy****</DhcpOptionsSetId>
    <Ipv6CidrBlock>2408:XXXX:0:a600::/56</Ipv6CidrBlock>
    <VSwitchIds>{"VSwitchId": [ "vsw-bp14cagpfysr29feg****" ]}</VSwitchIds>
    <UserCidrs>172.16.0.1/24</UserCidrs>
    <SecondaryCidrBlocks>192.168.0.0/16</SecondaryCidrBlocks>
    <AssociatedCens>
        <CenOwnerId>283117732402484000</CenOwnerId>
        <CenId>cen-7qthudw0ll6jmc****</CenId>
        <CenStatus>Attached</CenStatus>
    </AssociatedCens>
    <CloudResources>
        <ResourceCount>1</ResourceCount>
        <ResourceType>VSwitch</ResourceType>
    </CloudResources>
    <Ipv6CidrBlocks>
        <Ipv6Isp>BGP</Ipv6Isp>
        <Ipv6CidrBlock>2408:XXXX:0:6a::/56</Ipv6CidrBlock>
    </Ipv6CidrBlocks>
    <SupportIpv4Gateway>true</SupportIpv4Gateway>
    <Ipv4GatewayId>ipv4gw-5tsnc6s4ogsedtp3k****</Ipv4GatewayId>
</DescribeVpcAttributeResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CreationTime" : "2021-10-16T07:31:09Z",
  "Status" : "Available",
  "VpcId" : "vpc-bp18sth14qii3pnvo****",
  "IsDefault" : false,
  "ClassicLinkEnabled" : false,
  "OwnerId" : 283117732402484000,
  "RegionId" : "cn-hangzhou",
  "VpcName" : "doctest2",
  "VRouterId" : "vrt-bp1jso6ng1at0ajsc****",
  "DhcpOptionsSetStatus" : "Available",
  "CidrBlock" : "192.168.0.0/16",
  "RequestId" : "7486AE4A-129D-43DB-A714-2432C074BA04",
  "Description" : "VPC",
  "ResourceGroupId" : "rg-acfmxazbvgb4ph****",
  "DhcpOptionsSetId" : "dopt-o6w0df4epg9zo8isy****",
  "Ipv6CidrBlock" : "2408:XXXX:0:a600::/56",
  "VSwitchIds" : [ "{\"VSwitchId\": [ \"vsw-bp14cagpfysr29feg****\" ]}" ],
  "UserCidrs" : [ "172.16.0.1/24" ],
  "SecondaryCidrBlocks" : [ "192.168.0.0/16" ],
  "AssociatedCens" : [ {
    "CenOwnerId" : 283117732402484000,
    "CenId" : "cen-7qthudw0ll6jmc****",
    "CenStatus" : "Attached"
  } ],
  "CloudResources" : [ {
    "ResourceCount" : 1,
    "ResourceType" : "VSwitch"
  } ],
  "Ipv6CidrBlocks" : [ {
    "Ipv6Isp" : "BGP",
    "Ipv6CidrBlock" : "2408:XXXX:0:6a::/56"
  } ],
  "SupportIpv4Gateway" : true,
  "Ipv4GatewayId" : "ipv4gw-5tsnc6s4ogsedtp3k****"
}

错误码

HttpCode 错误码 错误信息 描述
400 IncorrectVpcStatus Current VPC status does not support this operation. 当前VPC的状态无法支持这个操作。
404 InvalidVpcId.NotFound Specified VPC does not exist. 该VPC不存在。
500 InternalError The request processing has failed due to some unknown error. 请求处理由于某些未知错误失败。

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