调用CreateGetDBListFromAgentTask接口创建通过备份网关获取数据库列表任务。

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

调试

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

请求参数

名称 位置 类型 是否必选 示例值 描述
Action Query String CreateGetDBListFromAgentTask

系统规定参数。取值:CreateGetDBListFromAgentTask

BackupGatewayId Query Long 160813

备份网关ID。

DatabaseType Query String MySQL

数据库类型,取值:

  • MySQL
  • MSSQL
  • Oracle
  • MongoDB
  • Redis
SourceEndpointRegion Query String cn-hangzhou

备份网关地域ID。

SourceEndpointIP Query String 123.0.0.1

数据库连接地址。

SourceEndpointPort Query Integer 3306

数据库连接端口。

RegionId Host String cn-hangzhou

地域ID。您可以调用DescribeRegions查询。

ClientToken Query String ETnLKlblzczshOTUbOCzxxxxxxxxxx

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

返回数据

名称 类型 示例值 描述
ErrCode String InvalidParameter

错误码字符串。

ErrMessage String This backupPlan can't support this action

错误信息。

HttpStatusCode Integer 400

错误码值。

RequestId String EB4DFD5E-3618-498D-BE35-4DBEA0072122

请求ID。

Success Boolean true

请求状态。

TaskId Long 123456

异步任务ID。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=CreateGetDBListFromAgentTask
&<公共请求参数>

正常返回示例

XML 格式

<CreateGetDBListFromAgentTaskResponse>
  <TaskId>123456</TaskId>
  <RequestId>EB4DFD5E-3618-498D-BE35-4DBEA0072122</RequestId>
  <HttpStatusCode>400</HttpStatusCode>
  <ErrMessage>This backupPlan can't support this action</ErrMessage>
  <Success>true</Success>
  <ErrCode>InvalidParameter</ErrCode>
</CreateGetDBListFromAgentTaskResponse>

JSON 格式

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

错误码

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