查詢已創(chuàng)建的VPC。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| vpc:DescribeVpcs | list | *VPC acs:vpc:{#regionId}:{#accountId}:vpc/**VPC acs:vpc:{#regionId}:{#accountId}:vpc/{#VPCId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| VpcId | string | 否 | VPC 的 ID。 最多支持指定 20 個 VPC ID，多個 VPC 的 ID 之間用半角逗號（,）隔開。 | vpc-bp1b1xjllp3ve5yze**** |
| RegionId | string | 是 | VPC 所在的地域 ID。 您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| VpcName | string | 否 | VPC 的名稱。 | Vpc-1 |
| IsDefault | boolean | 否 | 是否查詢指定地域下的默認(rèn) VPC，取值：
| false |
| DryRun | boolean | 否 | 是否只預(yù)檢此次請求，取值：
| false |
| ResourceGroupId | string | 否 | 要查詢的 VPC 所屬的資源組 ID。 | rg-acfmxvfvazb4p**** |
| PageNumber | integer | 否 | 列表的頁碼，默認(rèn)值為 1。 | 1 |
| PageSize | integer | 否 | 分頁查詢時每頁的行數(shù)，最大值為 50，默認(rèn)值為 10。 | 10 |
| VpcOwnerId | long | 否 | VPC 所屬的阿里云賬號 ID。 | 253460731706911258 |
| DhcpOptionsSetId | string | 否 | DHCP 選項集的 ID。 | dopt-o6w0df4epg9zo8isy**** |
| EnableIpv6 | boolean | 否 | 是否查詢指定地域下開啟 IPv6 網(wǎng)段的 VPC，默認(rèn)為空值（空值則不根據(jù)是否開啟 IPv6 網(wǎng)段做過濾），取值：
| false |
| Tag | array<object> | 否 | 資源的標(biāo)簽。 | |
| object | 否 | 標(biāo)簽。 | ||
| Key | string | 否 | 資源的標(biāo)簽鍵。最多支持輸入 20 個標(biāo)簽鍵。如需傳入該值，則不能輸入空字符串。 一個標(biāo)簽鍵最多支持 128 個字符，不能以 | FinanceDept |
| Value | string | 否 | 資源的標(biāo)簽值。最多支持輸入 20 個標(biāo)簽值。如需傳入該值，可以輸入空字符串。 最多支持 128 個字符，不能以 | FinanceJoshua |
返回參數(shù)
示例
正常返回示例
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 | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidVpcIdNumber.NotSupported | The number of vpcIds exceeds the limit. | vpcId數(shù)量超出限制 |
| 400 | InvalidAliuid | User Id is not valid. | - |
| 400 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | 資源組ID不存在。 |
| 400 | InvalidTagKey | The tag keys are not valid. | 無效的標(biāo)簽索引 |
| 400 | InvalidTagValue | The tag values are not valid. | 無效的標(biāo)簽值 |
| 400 | InvalidResourceGroupId.NotFound | The Specified ResourceGroupId not exists. | - |
| 400 | OperationUnsupported.ResourceGroupId | %s | - |
| 400 | IellgalParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | 指定參數(shù) OwnerAccount 不合法 |
| 400 | IllegalParam.OwnerId | The specified parameter VpcOwnerId is not valid. | - |
| 400 | InvalidAccount.NotFound | The account is invalid. | 操作失敗，使用了無效的調(diào)用賬號。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 請求處理由于某些未知錯誤失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-10-10 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2024-08-27 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2024-05-16 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-04-09 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-07-26 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-07-26 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-06-13 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |