全部產品
Search

搜尋本產品

    ENS：DescribeVSwitches - 查詢交換器資訊

    文件中心

    ENS：DescribeVSwitches - 查詢交換器資訊

    更新時間：Jun 05, 2026

    調用DescribeVSwitches查詢可組網的資訊，內網按vswitch進行組網。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ens:DescribeVSwitches

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    EnsRegionId

    string

    否

    ENS 節點 ID。

    cn-xian-unicom
    VSwitchId

    string

    否

    交換器 ID。

    vsw-5m9xhlq8oh***
    VSwitchName

    string

    否

    交換器名稱。

    testVSwitchName
    NetworkId

    string

    否

    要查詢的交換器所屬 VPC 的 ID。

    vpc-25cdvfeq58pl****
    PageNumber

    integer

    否

    列表的頁碼，預設值為 1。

    1
    PageSize

    integer

    否

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

    10
    EnsRegionIds

    array

    否

    ENS 節點 ID 數組。數組長度：1~100。

    string

    否

    ENS 節點 ID 數組。

    cn-chengdu-telecom-4
    VSwitchIds

    array

    否

    虛擬交換器 ID 數組。數組長度：1~100。

    string

    否

    虛擬交換器 ID 數組。

    vsw-5****tzrpf
    EnableIpv6

    boolean

    否

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PageSize

    integer

    當前查詢每頁的行數。

    2
    PageNumber

    integer

    當前查詢頁碼。

    1
    TotalCount

    integer

    列表資料總數。

    3
    VSwitches

    object

    VSwitch

    array<object>

    返回資料列表，詳見返回樣本（JSON 格式）VSwitch 對象數組。

    array<object>

    EnsRegionId

    string

    ENS 節點 ID。

    cn-xian-unicom
    Status

    string

    交換器的狀態，如下所示：

    • Pending：配置中。

    • Available：可用。

    Pending
    FreeIpCount

    integer

    可用 IP 數量。

    1024
    VSwitchId

    string

    交換器 ID。

    vsw-5m9xhlq8oh***
    CidrBlock

    string

    交換器的 IPv4 網段。

    10.21.224.0/22
    Description

    string

    交換器的描述資訊。

    VSwitchDescription
    NetworkId

    string

    網路識別碼。

    vpc-25cdvfeq58pl****
    CreatedTime

    string

    建立時間，使用 UTC 時間格式，格式為 yyyy-MM-ddTHH:mm:ssZ。

    2020-06-16T06:33:15Z
    VSwitchName

    string

    交換器名稱。

    testVSwitchName
    Tags

    object

    Tag

    array<object>

    標籤集合。

    object

    標籤集合。

    Value

    string

    標籤值。

    TestValue
    Key

    string

    標籤鍵。

    TestKey
    TagValue deprecated

    string

    標籤值。

    TestValue
    TagKey deprecated

    string

    標籤鍵。

    TestKey
    Ipv6CidrBlock

    string

    2408:XXXX:0:a600::/110

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize": 2,
  "PageNumber": 1,
  "TotalCount": 3,
  "VSwitches": {
    "VSwitch": [
      {
        "EnsRegionId": "cn-xian-unicom",
        "Status": "Pending",
        "FreeIpCount": 1024,
        "VSwitchId": "vsw-5m9xhlq8oh***",
        "CidrBlock": "10.21.224.0/22",
        "Description": "VSwitchDescription",
        "NetworkId": "vpc-25cdvfeq58pl****",
        "CreatedTime": "2020-06-16T06:33:15Z",
        "VSwitchName": "testVSwitchName",
        "Tags": {
          "Tag": [
            {
              "Value": "TestValue",
              "Key": "TestKey",
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "Ipv6CidrBlock": "2408:XXXX:0:a600::/110"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 NoPermission Permission denied.
    400 CallInterface Call Interface Happen Error. 介面調用出錯。
    400 ens.interface.error Failed to call API. 介面調用發生異常。
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

    變更歷史

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