Queries CreateGetDBListFromAgentTask databases through a backup gateway.

This operation returns the TaskId. You can use GetDBListFromAgent to do result query.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Position Type Required Example Description
Action Query String Required CreateGetDBListFromAgentTask

The operation that you want to perform. Valid values: CreateGetDBListFromAgentTask.

BackupGatewayId Query Long No 160813

The ID of the backup gateway.

DatabaseType Query String No MySQL

The database engine that the instances run. Valid values:

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

The ID of the region to which the backup gateway belongs.

SourceEndpointIP Query String No 123.0.0.1

The endpoint used to connect to the instance.

SourceEndpointPort Query Integer Optional 3306

The port used to connect to the database.

RegionId Host String No cn-hangzhou

The region ID of the instance. You can call DescribeRegions query.

ClientToken Query String No ETnLKlblzczshOTUbOCzxxxxxxxxxx

The client token that is used to ensure the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

Response parameters

Parameter Type Example Description
ErrCode String InvalidParameter

The error code string.

ErrMessage String This backupPlan can't support this action

The error message.

HttpStatusCode Integer 400

The error code value.

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

The request ID.

Success Boolean true

Indicates the status of the request.

TaskId Long 123456

The ID of the task.

Examples

Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=CreateGetDBListFromAgentTask
&<Common request parameters>

Sample success responses

XML format

<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 format

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

Error codes

For a list of error codes, visit the API Error Center.