全部產品
Search

搜尋本產品

    PolarDB：DescribeVSwitches

    文件中心

    PolarDB：DescribeVSwitches

    更新時間：Jun 09, 2026

    查詢交換機。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeVSwitches

    get

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    交換機所屬地域 ID。

    cn-hangzhou

    VpcId

    string

    否

    交換機所屬專有網路 ID。

    說明

    VpcId 和 DedicatedHostGroupId 參數至少輸入一個。

    vpc-25cdvfeq58pl****
    ZoneId

    string

    否

    交換機所屬可用區 ID。

    cn-hangzhou-d

    DedicatedHostGroupId

    string

    否

    專屬叢集 ID。

    說明

    VpcId 和 DedicatedHostGroupId 參數至少輸入一個。

    dhg-4n****
    PageNumber

    integer

    否

    清單的頁碼，預設值為 1。

    1

    PageSize

    integer

    否

    分頁查詢時每頁的行數，最大值為 50。預設值為 50。

    50
    ResourceGroupId

    string

    否

    交換機所屬的資源群組 ID。

    rg-bp67acfmxazb4ph****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    9A572171-4E27-40D1-BD36-D26C9E71E29E
    TotalCount

    integer

    清單條目數。

    1
    PageNumber

    integer

    目前頁碼。

    1
    PageSize

    integer

    每頁包含的條目數。

    10
    VSwitchs

    array<object>

    交換機清單。

    object

    CidrBlock

    string

    交換機的 IPv4 網段。

    172.16.0.0/24
    Description

    string

    交換機的描述資訊。

    vSwitchDescription

    IsDefault

    boolean

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

    • true：是預設交換機。

    • false：非預設交換機。

    true
    IzNo

    string

    NAT 閘道所屬的可用區。

    cn-hangzhou-b

    Status

    string

    交換機的狀態，取值：

    • Pending：設定中。

    • Available：可用。

    Available
    VSwitchId

    string

    交換機的 ID。

    vsw-25bcdxs7pv1****

    VSwitchName

    string

    交換機的名稱。

    vSwitch
    AvailableIpAddressCount

    integer

    交換機中可用的 IP 地址數量。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "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
    }
  ]
}

    錯誤碼

    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.

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

    變更歷史

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