全部產品
Search
文件中心

Data Management:GetDBListFromAgent

更新時間:Jun 26, 2026

該介面用於透過備份閘道獲取物理備份的庫表資料。

介面說明

您需要呼叫 CreateGetDBListFromAgentTask 介面建立一個非同步任務獲取 TaskId(非同步任務 ID)。將 TaskId 傳入 GetDBListFromAgent 介面後,即可獲取物理備份庫表資料。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dbs:GetDBListFromAgent

get

*All Resource

*

請求參數

名稱

類型

必填

描述

樣本值

BackupGatewayId

integer

備份閘道 ID,可透過呼叫 DescribeBackupGatewayList 介面獲取該參數的值。

說明

此參數為必填項。

160***

SourceEndpointRegion

string

備份閘道地域 ID。

cn-hangzhou

TaskId

integer

非同步任務 ID,呼叫 CreateGetDBListFromAgentTask 獲取該參數的值。

123456

ClientToken

string

用於保證請求的冪等性,防止重複提交請求。由用戶端產生該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字元,且該參數值中不能包含非 ASCII 字元。

ETnLKlblzczshOTUbOCzxxxxxxxxxx

返回參數

名稱

類型

描述

樣本值

object

返回值詳情如下。

HttpStatusCode

integer

錯誤碼值。

400

RequestId

string

請求 ID。

EB4DFD5E-3618-498D-BE35-4DBEA0072122

ErrCode

string

錯誤碼字串。

InvalidParameter

Success

boolean

請求成功狀態。

true

ErrMessage

string

錯誤資訊。

This backupPlan can't support this action

DbList

object

dbName

array

資料庫列表。

string

資料庫列表。

TaskDB

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 400,
  "RequestId": "EB4DFD5E-3618-498D-BE35-4DBEA0072122",
  "ErrCode": "InvalidParameter",
  "Success": true,
  "ErrMessage": "This backupPlan can't support this action",
  "DbList": {
    "dbName": [
      "TaskDB"
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

403 Request.Forbidden Have no Permissions

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

變更歷史

更多資訊,參考變更詳情