调用DescribeVpcs接口查询指定VPC。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVpcs |
系统规定参数。取值:DescribeVpcs。 |
VpcId | String | 否 | vpc-bp1b1xjllp3ve5yze**** |
VPC的ID。 最多支持指定20个VPC ID,多个VPC的ID之间用半角逗号(,)隔开。 |
RegionId | String | 是 | cn-hangzhou |
VPC所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 |
VpcName | String | 否 | Vpc-1 |
VPC的名称。 |
IsDefault | Boolean | 否 | false |
是否查询指定地域下的默认VPC,取值:
|
DryRun | Boolean | 否 | false |
是否只预检此次请求,取值:
|
ResourceGroupId | String | 否 | rg-acfmxvfvazb4p**** |
要查询的VPC所属的资源组ID。 |
PageNumber | Integer | 否 | 1 |
列表的页码,默认值为1。 |
PageSize | Integer | 否 | 10 |
分页查询时每页的行数,最大值为50,默认值为10。 |
VpcOwnerId | Long | 否 | 253460731706911258 |
VPC所属的阿里云账号ID。 |
DhcpOptionsSetId | String | 否 | dopt-o6w0df4epg9zo8isy**** |
DHCP选项集的ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Integer | 10 |
分页查询时每页的行数。 |
RequestId | String | C6532AA8-D0F7-497F-A8EE-094126D441F5 |
请求ID。 |
PageNumber | Integer | 1 |
列表的页码。 |
TotalCount | Integer | 2 |
列表条目数。 |
Vpcs | Array of Vpc |
VPC的详细信息。 |
|
Vpc | |||
CreationTime | String | 2021-04-18T15:02:37Z |
VPC的创建时间。 |
Status | String | Available |
VPC的状态,取值:
|
VpcId | String | vpc-bp1qpo0kug3a20qqe**** |
VPC的ID。 |
IsDefault | Boolean | false |
是否是该地域的默认VPC。取值:
|
OwnerId | Long | 253460731706911258 |
VPC所属的阿里云账号ID。 |
RegionId | String | cn-hangzhou |
VPC所在的地域ID。 |
VpcName | String | vpc1 |
VPC的名称。 |
VRouterId | String | vrt-bp1jcg5cmxjbl9xgc**** |
VPC路由器的ID。 |
DhcpOptionsSetStatus | String | Available |
DHCP选项集的状态。取值:
|
CidrBlock | String | 192.168.0.0/16 |
VPC的IPv4网段。 |
Description | String | This is my VPC. |
VPC的描述信息。 |
ResourceGroupId | String | rg-acfmxazb4ph**** |
VPC所属的资源组ID。 |
DhcpOptionsSetId | String | dopt-o6w0df4epg9zo8isy**** |
DHCP选项集的ID。 |
Ipv6CidrBlock | String | 2408:XXXX:0:a600::/56 |
VPC的IPv6网段。 |
CenStatus | String | Attached |
VPC绑定云企业网的状态。 仅VPC绑定了云企业网时返回Attached。 |
Tags | Array of Tag |
VPC的标签信息。 |
|
Tag | |||
Key | String | env |
VPC绑定的标签键。 |
Value | String | internal |
VPC绑定的标签值。 |
Ipv6CidrBlocks | Array of Ipv6CidrBlock |
VPC的IPv6网段信息。 |
|
Ipv6CidrBlock | |||
Ipv6Isp | String | BGP |
VPC的IPv6地址段类型,取值:
说明 如果是开通了单线带宽白名单的用户,该字段可以设置为ChinaTelecom(中国电信)、ChinaUnicom(中国联通)和ChinaMobile(中国移动)。
|
Ipv6CidrBlock | String | 2408:XXXX:0:a600::/56 |
VPC的IPv6网段。 |
VSwitchIds | Array of String | vsw-bp1nhbnpv2blyz8dl**** |
查询到的VPC中交换机的列表信息。 最多可以查询到VPC中最近创建的300个交换机的信息。如果您需要查询VPC中全部交换机的信息,可以执行DescribeVSwitches接口查询。 |
SecondaryCidrBlocks | Array of String | 192.168.20.0/24 |
VPC的附加网段。 |
UserCidrs | Array of String | 10.0.0.0/8 |
用户侧网段的列表。 |
NatGatewayIds | Array of String | nat-245xxxftwt45bg**** |
NAT网关的ID。 |
RouterTableIds | Array of String | vtb-bp1krxxzp0c29fmon**** |
路由表ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeVpcs
&VpcId=vpc-bp1b1xjllp3ve5yze****
&RegionId=cn-hangzhou
&VpcName=Vpc-1
&IsDefault=false
&DryRun=false
&ResourceGroupId=rg-acfmxvfvazb4p****
&PageNumber=1
&PageSize=10
&VpcOwnerId=253460731706911258
&DhcpOptionsSetId=dopt-o6w0df4epg9zo8isy****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeVpcsResponse>
<PageSize>10</PageSize>
<RequestId>C6532AA8-D0F7-497F-A8EE-094126D441F5</RequestId>
<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<Vpcs>
<CreationTime>2021-04-18T15:02:37Z</CreationTime>
<Status>Available</Status>
<VpcId>vpc-bp1qpo0kug3a20qqe****</VpcId>
<IsDefault>false</IsDefault>
<OwnerId>253460731706911260</OwnerId>
<RegionId>cn-hangzhou</RegionId>
<VpcName>vpc1</VpcName>
<VRouterId>vrt-bp1jcg5cmxjbl9xgc****</VRouterId>
<DhcpOptionsSetStatus>Available</DhcpOptionsSetStatus>
<CidrBlock>192.168.0.0/16</CidrBlock>
<Description>This is my VPC.</Description>
<ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
<DhcpOptionsSetId>dopt-o6w0df4epg9zo8isy****</DhcpOptionsSetId>
<Ipv6CidrBlock>2408:XXXX:0:a600::/56</Ipv6CidrBlock>
<CenStatus>Attached</CenStatus>
<Tags>
<Key>env</Key>
<Value>internal</Value>
</Tags>
<Ipv6CidrBlocks>
<Ipv6Isp>BGP</Ipv6Isp>
<Ipv6CidrBlock>2408:XXXX:0:a600::/56</Ipv6CidrBlock>
</Ipv6CidrBlocks>
<VSwitchIds>vsw-bp1nhbnpv2blyz8dl****</VSwitchIds>
<SecondaryCidrBlocks>192.168.20.0/24</SecondaryCidrBlocks>
<UserCidrs>10.0.0.0/8</UserCidrs>
<NatGatewayIds>nat-245xxxftwt45bg****</NatGatewayIds>
<RouterTableIds>vtb-bp1krxxzp0c29fmon****</RouterTableIds>
</Vpcs>
</DescribeVpcsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageSize" : 10,
"RequestId" : "C6532AA8-D0F7-497F-A8EE-094126D441F5",
"PageNumber" : 1,
"TotalCount" : 2,
"Vpcs" : [ {
"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" : [ {
"Key" : "env",
"Value" : "internal"
} ],
"Ipv6CidrBlocks" : [ {
"Ipv6Isp" : "BGP",
"Ipv6CidrBlock" : "2408:XXXX:0:a600::/56"
} ],
"VSwitchIds" : [ "vsw-bp1nhbnpv2blyz8dl****" ],
"SecondaryCidrBlocks" : [ "192.168.20.0/24" ],
"UserCidrs" : [ "10.0.0.0/8" ],
"NatGatewayIds" : [ "nat-245xxxftwt45bg****" ],
"RouterTableIds" : [ "vtb-bp1krxxzp0c29fmon****" ]
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | 资源组ID不存在。 |
500 | InternalError | The request processing has failed due to some unknown error. | 请求处理由于某些未知错误失败。 |
访问错误中心查看更多错误码。