DescribeVSwitchAttributes - 查詢指定交換器的配置資訊 - Virtual Private Cloud

調用DescribeVSwitchAttributes介面查詢指定交換器的配置資訊。

調試

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

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
VSwitchId	string	是	要查詢的交換器 ID。	vsw-25naue4g****
RegionId	string	否	路由表所屬的 VPC 的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會查詢交換器的配置資訊。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接查詢交換器的配置資訊。	false

返回參數

名稱	類型	描述	樣本值
	object	交換器的詳細資料。
VpcId	string	交換器所屬的 VPC ID。	vpc-257gq642n****
Status	string	交換器的狀態，取值： Pending：配置中。 Available：可用。	Pending
CreationTime	string	交換器的建立時間。	2021-08-22T10:40:25Z
IsDefault	boolean	是否是預設交換器。取值： true：預設交換器。 false：非預設交換器。	false
AvailableIpAddressCount	integer	可用 IP 數量。	12
NetworkAclId	string	網路 ACL 規則。	1
OwnerId	integer	資源歸屬的阿里雲帳號 ID。重要該值為 Long 類型，在某些語言中可能存在精度丟失的風險，請小心使用。	28768383240243****
VSwitchId	string	交換器的 ID。	vsw-25b7pv15t****
RequestId	string	請求 ID。	7B48B4B9-1EAD-469F-B488-594DAB4B6A1A
CidrBlock	string	交換器的私網位址範圍。	192.168.0.1/24
Description	string	交換器的描述。	abc
ResourceGroupId	string	資源群組 ID。	rg-acfmxazb4ph****
ZoneId	string	交換器的所屬可用性區域。	cn-beijing-a
Ipv6CidrBlock	string	交換器的 IPv6 網段。	2408:XXXX:3c5:44e::/64
VSwitchName	string	交換器名稱。	test
ShareType	string	交換器的共用類型。取值為空白時，表示該交換器為普通交換器。取值為 Shared 時，表示該交換器為共用交換器。取值為 Sharing 時，表示該交換器正在被他人共用。	Shared
EnabledIpv6	boolean	是否為交換器開啟 IPv6 網段並配置交換器的 IPv6 網段。取值： true：開啟。 false：不開啟。	true
RouteTable	object	交換器的路由表資訊。
RouteTableId	string	交換器關聯的路由表 ID。	vtb-bp145q7glnuzdv****
RouteTableType	string	路由表類型。取值： System：系統路由表。 Custom：自訂路由表。	System
Tags	object
Tag	array<object>	標籤列表資訊。
	object	標籤列表資訊。
Key	string	標籤鍵。	FinanceDept
Value	string	標籤值。	FinanceJoshua

樣本

正常返回樣本

JSON格式

{
  "VpcId": "vpc-257gq642n****",
  "Status": "Pending",
  "CreationTime": "2021-08-22T10:40:25Z",
  "IsDefault": false,
  "AvailableIpAddressCount": 12,
  "NetworkAclId": "1",
  "OwnerId": 0,
  "VSwitchId": "vsw-25b7pv15t****",
  "RequestId": "7B48B4B9-1EAD-469F-B488-594DAB4B6A1A",
  "CidrBlock": "192.168.0.1/24",
  "Description": "abc",
  "ResourceGroupId": "rg-acfmxazb4ph****",
  "ZoneId": "cn-beijing-a",
  "Ipv6CidrBlock": "2408:XXXX:3c5:44e::/64",
  "VSwitchName": "test",
  "ShareType": "Shared",
  "EnabledIpv6": true,
  "RouteTable": {
    "RouteTableId": "vtb-bp145q7glnuzdv****",
    "RouteTableType": "System"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidVSwitchId.NotFound	Specified VSwitch can not found.

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

變更歷史

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