全部產品
Search

搜尋本產品

    Data Management：DescribeBackupGatewayList - 查看備份網關列表

    文件中心

    Data Management：DescribeBackupGatewayList - 查看備份網關列表

    更新時間：Jan 13, 2026

    該介面用於查看DBS備份網關列表。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:DescribeBackupGatewayList

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Region

    string

    是

    DBS 地區，取值：

    • cn-hangzhou：公用雲端杭州

    • cn-shanghai：公用雲端上海

    • cn-qingdao：公用雲端青島

    • cn-beijing：公用雲端北京

    • cn-shenzhen：公用雲端深圳

    • cn-hongkong：公用雲端中國香港

    • ap-southeat-1：公用雲端新加坡

    • cn-hangzhou-finance：金融雲杭州

    • cn-shanghai-finance：金融雲上海

    • cn-shenzhen-finance：金融雲深圳

    cn-hangzhou
    Identifier

    string

    否

    備份網關唯一標識，支援多個查詢，用英文逗號（,）分隔。

    7213527653217
    PageSize

    integer

    否

    每頁的記錄數，取值：

    • 30

    • 50

    • 100

    說明

    預設為 30。

    30
    PageNum

    integer

    否

    頁碼，大於等於 0 且不超過 Integer 的最大值，預設值為：0。

    1
    ClientToken

    string

    否

    用於保證請求的等冪性，防止重複提交請求。

    ETnLKlblzczshOTUbOCzxxxxxxx

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    PageNum

    integer

    頁碼。

    1
    RequestId

    string

    請求 ID。

    46361705-8531-492F-807E-A97E482DD4A1
    ErrCode

    string

    錯誤碼。

    Param.NotFound
    Success

    boolean

    是否成功。

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.

    TotalPages

    integer

    總頁數。

    1
    TotalElements

    integer

    總備份網關數。

    0
    PageSize

    integer

    每頁的記錄數。

    30
    Items

    object

    BackupGateway

    array<object>

    備份網關詳情。

    object

    DisplayName

    string

    備份網關顯示名稱。

    test
    BackupGatewayCreateTime

    integer

    備份網關建立時間，取值 1554560477000。

    1554560477000
    BackupGatewayId

    string

    備份網關 ID。

    2321313123
    Region

    string

    地區。

    cn-hangzhou
    Identifier

    string

    備份網關唯一標識。

    sgdsajhdgu
    SourceEndpointInternetIP

    string

    安裝備份網關的主機公網 IP。

    XX.XX.XX.XX
    BackupGatewayStatus

    string

    備份網關狀態，取值：

    • ONLINE：線上

    • OFFLINE：離線

    • STOPPED：停止

    • UPGRADING：升級中

    ONLINE
    SourceEndpointIntranetIP

    string

    安裝備份網關的主機私網 IP。

    XX.XX.XX.XX
    LastHeartbeatTime

    integer

    上次心跳彙報時間，取值：1554560477000。

    1554560477000
    SourceEndpointHostname

    string

    安裝備份網關的主機名稱。

    test

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "46361705-8531-492F-807E-A97E482DD4A1",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "TotalPages": 1,
  "TotalElements": 0,
  "PageSize": 30,
  "Items": {
    "BackupGateway": [
      {
        "DisplayName": "test",
        "BackupGatewayCreateTime": 1554560477000,
        "BackupGatewayId": "2321313123",
        "Region": "cn-hangzhou",
        "Identifier": "sgdsajhdgu",
        "SourceEndpointInternetIP": "XX.XX.XX.XX",
        "BackupGatewayStatus": "ONLINE",
        "SourceEndpointIntranetIP": "XX.XX.XX.XX",
        "LastHeartbeatTime": 1554560477000,
        "SourceEndpointHostname": "test"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    403 Request.Forbidden Have no Permissions 當前操作未被授權，請聯絡主帳號在RAM控制台進行授權後再執行操作

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

    變更歷史

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