CreateGetDBListFromAgentTask - 创建数据库列表任务_数据管理（兼容数据库备份）(DMS)-阿里云帮助中心

该接口用于通过备份网关获取数据库列表任务。

接口说明

本 API 操作会返回 TaskId，您可以使用 GetDBListFromAgent 接口做结果查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
BackupGatewayId	long	否	备份网关 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	long	异步任务 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控制台进行授权后再执行操作

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史