DescribeVpcAttribute - Virtual Private Cloud

查詢指定 VPC 的配置資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
VpcId	string	是	要查詢的 VPC 的 ID。	vpc-bp18sth14qii3pnv****
RegionId	string	是	VPC 所屬的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
DryRun	boolean	否	是否只預檢此次請求。取值： true：傳送檢查請求，不會查詢資源狀況。檢查項目包括 AccessKey 是否有效、RAM 使用者的授權情況和是否填寫了必需參數。如果檢查不通過，則傳回對應錯誤。如果檢查通過，會傳回錯誤碼 `DryRunOperation`。 false（預設值）：傳送正常請求，通過檢查後傳回 2xx HTTP 狀態碼並直接查詢資源狀況。	false
IsDefault	boolean	否	是否為預設 VPC，取值： false（預設值）：不是預設 VPC。 true：是預設 VPC。	false

返回參數

名稱	類型	描述	樣本值
	object	VPC 的建立時間。
CreationTime	string	VPC 的建立時間。時間按照 ISO 8601 標準表示，使用 UTC 時間，格式為 YYYY-MM-DDThh:mm:ssZ。	2021-10-16T07:31:09Z
Status	string	VPC 的狀態。取值： Available：可用。 Pending：設定中。	Available
VpcId	string	VPC 的 ID。	vpc-bp18sth14qii3pnvo****
IsDefault	boolean	是否為預設 VPC。取值： true：是預設 VPC。 false（預設值）：非預設 VPC。	false
ClassicLinkEnabled `deprecated`	boolean	是否開啟了 ClassicLink 功能。取值： true：已開啟。 false（預設值）：未開啟。	false
OwnerId	integer	VPC 所屬的帳號 ID。	28311773240248****
RegionId	string	VPC 所在的地域 ID。	cn-hangzhou
VpcName	string	VPC 的名稱。	doctest2
VRouterId	string	VPC 的路由器 ID。	vrt-bp1jso6ng1at0ajsc****
DhcpOptionsSetStatus	string	DHCP 選項集的狀態。取值： Available：可用。 InUse：使用中。 Deleted：已刪除。 Pending：設定中。	Available
CidrBlock	string	VPC 的 IPv4 網段。	192.168.0.0/16
RequestId	string	請求 ID。	7486AE4A-129D-43DB-A714-2432C074BA04
Description	string	VPC 的描述。	VPC
ResourceGroupId	string	資源群組 ID。	rg-acfmxazbvgb4ph****
DhcpOptionsSetId	string	DHCP 選項集的 ID。	dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlock	string	VPC 的 IPv6 網段。	2408:XXXX:0:a600::/56
VSwitchIds	object
VSwitchId	array	VPC 下的交換器清單。
	string	VPC 下的交換器清單。	{"VSwitchId": [ "vsw-bp14cagpfysr29feg****" ]}
UserCidrs	object
UserCidr	array	使用者側網路的網段，如定義了多個網段，傳回時會以半形逗號（,）隔開，最多支援 3 個網段。
	string	使用者側網路的網段，如定義了多個網段，傳回時會以半形逗號（,）隔開，最多支援 3 個網段。	172.16.0.1/24
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	VPC 附加 IPv4 網段。
	string	VPC 附加 IPv4 網段。	192.168.0.0/16
AssociatedCens	object
AssociatedCen	array<object>	繫結的雲端企業網路清單。如果 VPC 未綁定雲端企業網路，則不傳回該參數。
	object	雲端企業網路所屬帳號的 ID。
CenOwnerId	integer	雲端企業網路所屬帳號的 ID。	28311773240248****
CenId	string	VPC 綁定的雲端企業網路執行個體 ID。	cen-7qthudw0ll6jmc****
CenStatus	string	VPC 綁定雲端企業網路的狀態。僅 VPC 綁定了雲端企業網路時傳回 Attached。	Attached
CloudResources	object
CloudResourceSetType	array<object>	VPC 下的資源清單。
	object	VPC 下的資源數量。
ResourceCount	integer	VPC 下的資源數量。	1
ResourceType	string	VPC 下的資源類型。取值： VSwitch：交換器。 VRouter：路由器。 RouteTable：路由表。	VSwitch
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:6a::/56
SupportIpv4Gateway	boolean	VPC 是否運作於 IPv4 閘道器集中控制模式。 true：IPv4 閘道器集中控制模式，公網流量受 IPv4 閘道器集中管控（IPv4 閘道器建立且設定路由後啟用），或純私有網路 VPC（IPv4 閘道器選擇私有網路模式刪除）。 false：公網直接存取模式。說明詳情可參考文件 IPv4 閘道器。	true
Ipv4GatewayId	string	IPv4 閘道器的執行個體 ID。	ipv4gw-5tsnc6s4ogsedtp3k****
Tags	object
Tag	array<object>	標籤清單資訊。
	object	標籤清單資訊。
Key	string	標籤鍵。	FinanceDept
Value	string	標籤值。	FinanceJoshua
AssociatedPropagationSources	object
AssociatedPropagationSources	array<object>	VPC 關聯路由傳播來源。
	object
SourceType	string	傳播來源類型。 CEN：雲端企業網路。 VPN：VPN 閘道器。 TR：轉發路由器。 ECR：專線閘道器。	CEN
SourceOwnerId	integer	傳播來源所屬帳號的 ID。	153980532164****
SourceInstanceId	string	傳播來源執行個體 ID。	cen-dc4vwznpwbobrl****
Status	string	綁定狀態。 Attaching：綁定中。 Attached：已綁定。 Detaching：解除綁定中。	Attaching
RoutePropagated	boolean	是否給本 VPC 傳播路由。	true
EnabledIpv6	boolean	是否開啟 IPv6。枚舉值： false : false true : true	false
DnsHostnameStatus	string	是否開啟 DNS 主機名稱。	DISABLED

樣本

正常返回樣本

JSON格式

{
  "CreationTime": "2021-10-16T07:31:09Z",
  "Status": "Available",
  "VpcId": "vpc-bp18sth14qii3pnvo****",
  "IsDefault": false,
  "ClassicLinkEnabled": false,
  "OwnerId": 0,
  "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": [
      "{\"VSwitchId\": [ \"vsw-bp14cagpfysr29feg****\" ]}"
    ]
  },
  "UserCidrs": {
    "UserCidr": [
      "172.16.0.1/24"
    ]
  },
  "SecondaryCidrBlocks": {
    "SecondaryCidrBlock": [
      "192.168.0.0/16"
    ]
  },
  "AssociatedCens": {
    "AssociatedCen": [
      {
        "CenOwnerId": 0,
        "CenId": "cen-7qthudw0ll6jmc****",
        "CenStatus": "Attached"
      }
    ]
  },
  "CloudResources": {
    "CloudResourceSetType": [
      {
        "ResourceCount": 1,
        "ResourceType": "VSwitch"
      }
    ]
  },
  "Ipv6CidrBlocks": {
    "Ipv6CidrBlock": [
      {
        "Ipv6Isp": "BGP",
        "Ipv6CidrBlock": "2408:XXXX:0:6a::/56"
      }
    ]
  },
  "SupportIpv4Gateway": true,
  "Ipv4GatewayId": "ipv4gw-5tsnc6s4ogsedtp3k****",
  "Tags": {
    "Tag": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  },
  "AssociatedPropagationSources": {
    "AssociatedPropagationSources": [
      {
        "SourceType": "CEN",
        "SourceOwnerId": 0,
        "SourceInstanceId": "cen-dc4vwznpwbobrl****",
        "Status": "Attaching",
        "RoutePropagated": true
      }
    ]
  },
  "EnabledIpv6": false,
  "DnsHostnameStatus": "DISABLED"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	IncorrectVpcStatus	Current VPC status does not support this operation.
400	Forbidden.VpcNotFound	Specified VPC does not exist.
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidVpcId.NotFound	Specified VPC does not exist.

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

變更歷史

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