調用CreateGetDBListFromAgentTask通過備份網關擷取資料庫列表-Data Management-阿里雲 - Data Management

介面說明

本 API 操作會返回 TaskId，您可以使用 GetDBListFromAgent 介面做結果查詢。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dbs:CreateGetDBListFromAgentTask

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
BackupGatewayId	integer	否	備份網關 ID，可通過調用 DescribeBackupPlanList 介面查看。說明此參數為必填項。	160813
DatabaseType	string	否	資料庫類型，取值： MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis	MySQL
SourceEndpointRegion	string	否	備份網關地區 ID。	cn-hangzhou
SourceEndpointIP	string	否	資料庫連接地址。	123.0.XX.XX
SourceEndpointPort	integer	否	資料庫連接連接埠。	3306
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
TaskId	integer	非同步任務 ID。	123456

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

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

變更歷史

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