全部產品
Search

搜尋本產品

    PolarDB：DescribeVSwitchList - 查詢交換器列表

    文件中心

    PolarDB：DescribeVSwitchList - 查詢交換器列表

    更新時間：Dec 15, 2025

    查詢交換器資訊

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeVSwitchList

    none

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    交換器所在地區 ID。

    說明

    您可以調用 DescribeRegions 查詢交換器支援的所有地區 ID。

    cn-hangzhou
    VpcId

    string

    否

    VPC ID。

    說明

    可通過介面 DescribeVpcs 查看 VPC 資訊詳情。

    vpc-25cdvfeq58pl****
    VSwitchIds

    array

    否

    VPC 下的交換器列表。

    string

    否

    指定多個交換器 ID。

    vsw-uf6quheh6ok8nbtj4****
    ZoneId

    string

    否

    交換器所屬可用性區域 ID。

    cn-hangzhou-g
    PageNumber

    integer

    否

    頁碼，取值範圍為大於 0 但不超過 Integer 最大值的整數。

    1
    PageSize

    integer

    否

    每頁記錄數，取值範圍如下：

    • 30

    • 50

    • 100

    預設值為 30。

    30

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID

    6A2EE5B4-CC9F-46E1-A747-E43BC9******
    TotalCount

    integer

    列表條目數。

    1
    PageNumber

    integer

    查詢結果的頁碼。

    1
    PageSize

    integer

    每頁記錄數，取值範圍如下：

    • 30

    • 50

    • 100

    預設值為 30。

    30
    VSwitchs

    array<object>

    交換器列表。

    object

    交換器資訊詳情。

    CidrBlock

    string

    交換器網段。

    172.16.0.0/24
    Description

    string

    交換器的描述資訊。

    vSwitchDescription

    IsDefault

    boolean

    是否是預設交換器，取值：

    • true：是預設交換器。

    • false：非預設交換器。

    true
    IzNo

    string

    交換器所屬可用性區域 ID。

    cn-hangzhou-b

    Status

    string

    交換器的狀態，取值：

    • Pending：配置中。

    • Available：可用。

    Available
    VSwitchId

    string

    交換器的 ID。

    vsw-25bcdxs7pv1****

    VSwitchName

    string

    交換器的名稱。

    vSwitch
    AvailableIpAddressCount

    integer

    交換器中可用的 IP 位址數量。

    1
    VpcId

    string

    專用網路 ID。

    vpc-bp1vbkkyt7apvy4j*****
    ShareType

    string

    參數共用類型

    Public
    ResourceGroupId

    string

    資源群組 ID。

    rg-************
    OwnerId

    string

    所有者主帳號 ID

    177563751276****

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "6A2EE5B4-CC9F-46E1-A747-E43BC9******",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "VSwitchs": [
    {
      "CidrBlock": "172.16.0.0/24",
      "Description": "vSwitchDescription\t\n",
      "IsDefault": true,
      "IzNo": "cn-hangzhou-b\t\n",
      "Status": "Available",
      "VSwitchId": "vsw-25bcdxs7pv1****\t\n",
      "VSwitchName": "vSwitch",
      "AvailableIpAddressCount": 1,
      "VpcId": "vpc-bp1vbkkyt7apvy4j*****",
      "ShareType": "Public",
      "ResourceGroupId": "rg-************",
      "OwnerId": "177563751276****"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidVSwitchId.NotFound Specified virtual switch is not found in specified VPC.
    400 IncorrecttVpcId The specified parameter VPCId is not valid.
    400 InvalidIzNo.NotSupported Specified VPC zone is not supported.
    400 MissingParameter.RegionId The parameter RegionId is mandatory.

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

    變更歷史

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