DescribeVpcs

查詢已建立的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}

vpc:tag

無

請求參數

名稱	類型	必填	描述	樣本值
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，取值： true（預設值）：查詢指定地域下的預設 VPC。 false：不查詢預設 VPC。	false
DryRun	boolean	否	是否只預檢此次請求，取值： true：傳送檢查請求，不會查詢資源狀況。檢查項包括 AccessKey 是否有效、RAM 使用者的授權情況和是否填寫了必需參數。如果檢查不通過，則返回對應錯誤。如果檢查通過，會返回錯誤碼`DryRunOperation`。 false（預設值）：傳送正常請求，通過檢查後返回 HTTP 2xx 狀態碼並直接查詢資源狀況。	false
ResourceGroupId	string	否	要查詢的 VPC 所屬的資源群組 ID。	rg-acfmxvfvazb4p****
PageNumber	integer	否	列表的頁碼，預設值為 1。	1
PageSize	integer	否	分頁查詢時每頁的行數，最大值為 50，預設值為 10。	10
VpcOwnerId	integer	否	VPC 所屬的阿里雲帳號 ID。	253460731706911258
DhcpOptionsSetId	string	否	DHCP 選項集的 ID。	dopt-o6w0df4epg9zo8isy****
EnableIpv6	boolean	否	是否查詢指定地域下開啟 IPv6 網段的 VPC，預設為空值（空值則不根據是否開啟 IPv6 網段做過濾），取值： false：不開啟。 true：開啟。	false
Tag	array<object>	否	資源的標籤。
	object	否	標籤。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入空字串。一個標籤鍵最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入空字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	object	返回的資訊。
PageSize	integer	分頁查詢時每頁的行數。	10
RequestId	string	請求 ID。	C6532AA8-D0F7-497F-A8EE-094126D441F5
PageNumber	integer	列表的頁碼。	1
TotalCount	integer	列表條目數。	2
Vpcs	object
Vpc	array<object>	VPC 的詳細資訊。
	array<object>	VPC 的詳細資訊。
CreationTime	string	VPC 的建立時間。	2021-04-18T15:02:37Z
Status	string	VPC 的狀態，取值： Pending：配置中。 Available：可用。	Available
VpcId	string	VPC 的 ID。	vpc-bp1qpo0kug3a20qqe****
IsDefault	boolean	是否是該地區的預設 VPC。取值： true：是該地區的預設 VPC。 false：不是該地區的預設 VPC。	false
OwnerId	integer	VPC 所屬的阿里雲帳號 ID。	253460731706911258
RegionId	string	VPC 所在的地區 ID。	cn-hangzhou
VpcName	string	VPC 的名稱。	vpc1
VRouterId	string	VPC 路由器的 ID。	vrt-bp1jcg5cmxjbl9xgc****
DhcpOptionsSetStatus	string	DHCP 選項集的狀態。取值： Available：可用。 InUse：使用中。 Deleted：已刪除。 Pending：配置中。	Available
CidrBlock	string	VPC 的 IPv4 網段。	192.168.0.0/16
Description	string	VPC 的描述資訊。	This is my VPC.
ResourceGroupId	string	VPC 所屬的資源群組 ID。	rg-acfmxazb4ph****
DhcpOptionsSetId	string	DHCP 選項集的 ID。	dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlock	string	VPC 的 IPv6 網段。	2408:XXXX:0:a600::/56
CenStatus	string	VPC 綁定雲企業網的狀態。僅 VPC 綁定了雲企業網時返回 Attached。	Attached
Tags	object
Tag	array<object>	VPC 的標籤資訊。
	object	VPC 的標籤資訊。
Key	string	VPC 綁定的標籤鍵。	FinanceDept
Value	string	VPC 綁定的標籤值。	FinanceJoshua
Ipv6CidrBlocks	object
Ipv6CidrBlock	array<object>	VPC 的 IPv6 網段資訊。
	object	VPC 的 IPv6 網段資訊。
Ipv6Isp	string	VPC 的 IPv6 位址區段類型，取值： BGP：阿里雲 BGP IPv6。 ChinaMobile：中國移動（單線）。 ChinaUnicom：中國聯通（單線）。 ChinaTelecom：中國電信（單線）。說明如果是開通了單線頻寬白名單的使用者，該欄位可以設定為 ChinaTelecom（中國電信）、ChinaUnicom（中國聯通）和 ChinaMobile（中國移動）。	BGP
Ipv6CidrBlock	string	VPC 的 IPv6 網段。	2408:XXXX:0:a600::/56
VSwitchIds	object
VSwitchId	array	查詢到的 VPC 中交換器的列表資訊。最多可以查詢到 VPC 中最近建立的 300 個交換器的資訊。如果您需要查詢 VPC 中全部交換器的資訊，可以執行 DescribeVSwitches 介面查詢。
	string	查詢到的 VPC 中交換器的列表資訊。最多可以查詢到 VPC 中最近建立的 300 個交換器的資訊。如果您需要查詢 VPC 中全部交換器的資訊，可以執行 DescribeVSwitches 介面查詢。	vsw-bp1nhbnpv2blyz8dl****
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	附加網段資訊。
	string	VPC 的附加網段。	192.168.20.0/24
UserCidrs	object
UserCidr	array	使用者側網段的列表。
	string	使用者側網段的列表。	10.0.0.0/8
NatGatewayIds	object
NatGatewayIds	array	NAT Gateway 的 ID。
	string	NAT Gateway 的 ID。	nat-245xxxftwt45bg****
RouterTableIds	object
RouterTableIds	array	路由表資訊。
	string	路由表 ID。	vtb-bp1krxxzp0c29fmon****
EnabledIpv6	boolean	是否開啟 IPv6。取值： false：未開啟。 true：已開啟。	false
DnsHostnameStatus	string	是否開啟 DNS 主機名稱。	DISABLED

樣本

正常返回樣本

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.
400	InvalidAliuid	User Id is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.
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.
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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。