调用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 | 是否只预检此次请求。取值:
|
| IsDefault | Boolean | 否 | false | 是否为默认VPC,取值:
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| CreationTime | String | 2021-10-16T07:31:09Z | VPC的创建时间。 |
| Status | String | Available | VPC的状态。取值:
|
| VpcId | String | vpc-bp18sth14qii3pnvo**** | VPC的ID。 |
| IsDefault | Boolean | false | 是否是默认VPC。取值:
|
| ClassicLinkEnabled | Boolean | false | 是否开启了ClassicLink功能。取值:
|
| 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选项集的状态。取值:
|
| 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下的资源类型。取值:
|
| Ipv6CidrBlocks | Array of Ipv6CidrBlock | VPC的IPv6网段信息。 |
|
| Ipv6CidrBlock | |||
| Ipv6Isp | String | BGP | VPC的IPv6地址段类型。取值:
说明 如果是开通了单线带宽白名单的用户,该字段可以设置为ChinaTelecom(中国电信)、ChinaUnicom(中国联通)和ChinaMobile(中国移动)。 |
| Ipv6CidrBlock | String | 2408:XXXX:0:6a::/56 | VPC的IPv6网段。 |
| SupportIpv4Gateway | Boolean | true | 是否支持IPv4网关。
|
| Ipv4GatewayId | String | ipv4gw-5tsnc6s4ogsedtp3k**** | IPv4网关的实例ID。 |
| Tags | Array of Tag | 标签列表信息。 |
|
| Tag | |||
| Key | String | FinanceDept | 标签键。 |
| Value | String | FinanceJoshua | 标签值。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeVpcAttribute
&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>
<Tags>
<Key>FinanceDept</Key>
<Value>FinanceJoshua</Value>
</Tags>
</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****",
"Tags" : [ {
"Key" : "FinanceDept",
"Value" : "FinanceJoshua"
} ]
}
错误码
| 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. | 请求处理由于某些未知错误失败。 |
访问错误中心查看更多错误码。