DescribeVSwitches - Virtual Private Cloud

查詢可組網的資訊，內網按 vSwitch 進行組網。

介面說明

DescribeVSwitches 介面在頻繁深翻頁跳頁情況下可能返回 Throttling.DeepPageSkip 錯誤碼，請降低查詢頻率或採用順序翻頁。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeVSwitches

list

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/*

vpc:VPC

無

請求參數

名稱	類型	必填	描述	樣本值
VpcId	string	否	要查詢的交換器所屬 VPC 的 ID。說明 RegionId 和 VpcId 參數至少輸入一個。	vpc-25cdvfeq58pl****
VSwitchId	string	否	要查詢的交換器的 ID。	vsw-23dscddcffvf3****
ZoneId	string	否	交換器所屬可用區的 ID。您可以透過呼叫 DescribeZones 介面取得可用區 ID。	cn-hangzhou-d
RegionId	string	否	交換器所屬地域的 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。說明 RegionId 和 VpcId 參數至少輸入一個。	cn-hangzhou
VSwitchName	string	否	交換器的名稱。名稱長度為 1～128 個字元，不能以 `http://` 或 `https://` 開頭。	vSwitch
DryRun	boolean	否	是否僅預檢此次請求。取值： true：發送檢查請求，不會建立資源（介面功能）。檢查項目包括是否填寫了必要參數、請求格式、業務限制。如果檢查未通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 `DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態碼並直接進行操作。	true
IsDefault	boolean	否	是否查詢指定地域下的預設交換器，取值： true：查詢指定地域下的預設交換器。 false：不查詢指定地域下的預設交換器。如果不傳入該參數，系統預設查詢指定地域下的所有交換器。	true
RouteTableId	string	否	路由表的 ID。	vtb-bp145q7glnuzdvzu2****
ResourceGroupId	string	否	交換器所屬的資源群組 ID。	rg-bp67acfmxazb4ph****
PageNumber	integer	否	列表的頁碼，預設值為 1。	1
PageSize	integer	否	分頁查詢時每頁的列數，最大值為 50。預設值為 10。	10
VSwitchOwnerId	integer	否	資源歸屬的阿里雲帳號 ID。	2546073170691****
EnableIpv6	boolean	否	是否查詢指定地域下開啟 IPv6 網段的交換器，取值： true：查詢指定地域下開啟 IPv6 網段的交換器。 false：不查詢指定地域下開啟 IPv6 網段的交換器。如果不傳入該參數，系統預設查詢指定地域下的所有交換器。	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。	9A572171-4E27-40D1-BD36-D26C9E71E29E
PageNumber	integer	目前頁碼。	1
TotalCount	integer	列表條目數。	1
VSwitches	object
VSwitch	array<object>	交換器的詳細資訊。
	array<object>	交換器資料結構體。
VpcId	string	交換器所屬 VPC 的 ID。	vpc-257gcdcdq64****
Status	string	交換器的狀態，取值： Pending：設定中。 Available：可用。	Available
CreationTime	string	交換器的建立時間。	2022-01-18T12:43:57Z
IsDefault	boolean	是否是預設交換器。取值： true：是預設交換器。 false：非預設交換器。	true
AvailableIpAddressCount	integer	交換器中可用的 IP 位址數量。	1
NetworkAclId	string	網路 ACL 的 ID。	nacl-a2do9e413e0spzasx****
OwnerId	integer	資源歸屬的阿里雲帳號 ID。	25346073170691****
VSwitchId	string	交換器的 ID。	vsw-25bcdxs7pv1****
CidrBlock	string	交換器的 IPv4 網段。	172.16.0.0/24
Description	string	交換器的描述資訊。	VSwitchDescription
ResourceGroupId	string	交換器所屬的資源群組 ID。	rg-acfmxazb4ph6aiy****
ZoneId	string	交換器所屬的可用區。	cn-hangzhou-d
Ipv6CidrBlock	string	交換器的 IPv6 網段。	2408:4002:10c4:4e03::/64
VSwitchName	string	交換器的名稱。	vSwitch
ShareType	string	交換器的共用類型。取值為空時，表示該交換器為普通交換器。取值為 Shared 時，表示該交換器為共用交換器。取值為 Sharing 時，表示該交換器正在被他人共用。	Shared
EnabledIpv6	boolean	是否為交換器開啟 IPv6 網段並設定交換器的 IPv6 網段。取值如下： true：開啟。 false：不開啟。	true
Tags	object
Tag	array<object>	交換器標籤資訊。
	object	標籤資訊資料結構體。
Key	string	交換器綁定的標籤鍵。	department
Value	string	交換器綁定的標籤值。	dev
RouteTable	object	路由表資訊。
RouteTableId	string	交換器關聯的路由表 ID。	vrt-bp145q7glnuzdv****
RouteTableType	string	交換器關聯的路由表的類型： System：系統路由表。 Custom：自訂路由表。	System

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "PageNumber": 1,
  "TotalCount": 1,
  "VSwitches": {
    "VSwitch": [
      {
        "VpcId": "vpc-257gcdcdq64****",
        "Status": "Available",
        "CreationTime": "2022-01-18T12:43:57Z",
        "IsDefault": true,
        "AvailableIpAddressCount": 1,
        "NetworkAclId": "nacl-a2do9e413e0spzasx****",
        "OwnerId": 0,
        "VSwitchId": "vsw-25bcdxs7pv1****",
        "CidrBlock": "172.16.0.0/24",
        "Description": "VSwitchDescription",
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "ZoneId": "cn-hangzhou-d",
        "Ipv6CidrBlock": "2408:4002:10c4:4e03::/64",
        "VSwitchName": "vSwitch",
        "ShareType": "Shared",
        "EnabledIpv6": true,
        "Tags": {
          "Tag": [
            {
              "Key": "department",
              "Value": "dev"
            }
          ]
        },
        "RouteTable": {
          "RouteTableId": "vrt-bp145q7glnuzdv****",
          "RouteTableType": "System"
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Forbidden.VpcNotFound	Specified VPC can not found.	指定的 VPC 不存在，請您檢查 VPC 是否正確。
400	InvalidTagKey	The tag keys are not valid.	無效的標籤索引。
400	InvalidTagValue	The tag values are not valid.	無效的標籤值。
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	指定參數 OwnerAccount 不合法。
400	IllegalParam.OwnerId	The specified parameter VSwitchOwnerId is not valid.
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	vpcId 數量超出限制。
400	InvalidVSwitchIdNumber.NotSupported	The number of vSwitchIds exceeds the limit.
400	Throttling.DeepPageSkip	Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination.	深分頁跳頁次數已觸發限流。請降低深翻頁跳頁的頻率，或使用順序分頁。
404	InvalidVSwitchId.NotFound	VSwitch not exist.

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

變更歷史

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