查询已创建的VPC。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:DescribeVpcs | list | VPC acs:vpc:{#regionId}:{#accountId}:vpc/*VPC acs:vpc:{#regionId}:{#accountId}:vpc/{#VPCId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| VpcId | string | 否 | VPC 的 ID。 最多支持指定 20 个 VPC ID，多个 VPC 的 ID 之间用半角逗号（,）隔开。 | vpc-bp1b1xjllp3ve5yze**** |
| RegionId | string | 是 | VPC 所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
| VpcName | string | 否 | VPC 的名称。 | Vpc-1 |
| IsDefault | boolean | 否 | 是否查询指定地域下的默认 VPC，取值：
| false |
| DryRun | boolean | 否 | 是否只预检此次请求，取值：
| false |
| ResourceGroupId | string | 否 | 要查询的 VPC 所属的资源组 ID。 | rg-acfmxvfvazb4p**** |
| PageNumber | integer | 否 | 列表的页码，默认值为 1。 | 1 |
| PageSize | integer | 否 | 分页查询时每页的行数，最大值为 50，默认值为 10。 | 10 |
| VpcOwnerId | long | 否 | VPC 所属的阿里云账号 ID。 | 253460731706911258 |
| DhcpOptionsSetId | string | 否 | DHCP 选项集的 ID。 | dopt-o6w0df4epg9zo8isy**** |
| EnableIpv6 | boolean | 否 | 是否查询指定地域下开启 IPv6 网段的 VPC，默认为空值（空值则不根据是否开启 IPv6 网段做过滤），取值：
| false |
| Tag | array<object> | 否 | 资源的标签。 | |
| object | 否 | 标签。 | ||
| Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。 一个标签键最多支持 128 个字符，不能以 | FinanceDept |
| Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。 最多支持 128 个字符，不能以 | FinanceJoshua |
返回参数
示例
正常返回示例
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,
"DnsHostnameStatus": "DISABLED"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidVpcIdNumber.NotSupported | The number of vpcIds exceeds the limit. | vpcId数量超出限制 |
| 400 | InvalidAliuid | User Id is not valid. | - |
| 400 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | 资源组ID不存在。 |
| 400 | InvalidTagKey | The tag keys are not valid. | 无效的标签索引 |
| 400 | InvalidTagValue | The tag values are not valid. | 无效的标签值 |
| 400 | InvalidResourceGroupId.NotFound | The Specified ResourceGroupId not exists. | - |
| 400 | OperationUnsupported.ResourceGroupId | %s | - |
| 400 | IellgalParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | 指定参数 OwnerAccount 不合法 |
| 400 | IllegalParam.OwnerId | The specified parameter VpcOwnerId is not valid. | - |
| 400 | InvalidAccount.NotFound | The account is invalid. | 操作失败，使用了无效的调用账号。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 请求处理由于某些未知错误失败。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-10 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-08-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-05-16 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-04-09 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-26 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-07-26 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-06-13 | OpenAPI 错误码发生变更 | 查看变更详情 |