After you call this operation to obtain the target TaskId, you can call this operation to query the task ID.

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 Type Required Example Description
Action String Yes GetDBListFromAgent

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

BackupGatewayId Long No 160813

The ID of the backup gateway.

SourceEndpointRegion String No cn-hangzhou

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

TaskId Long No 123456

The ID of the task.

RegionId String No cn-hangzhou

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

ClientToken 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
DbList List TaskDB

The list of databases.

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 ID of the request.

Success Boolean true

The success status of the request.

Examples

Sample requests

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

Sample success responses

XML format

<GetDBListFromAgentReponse>
      <RequestId>EB4DFD5E-3618-498D-BE35-4DBEA0072122</RequestId>
      <HttpStatusCode>400</HttpStatusCode>
      <ErrMessage>This backupPlan can't support this action</ErrMessage>
      <Success>true</Success>
      <DbList>
            <dbName>TaskDB</dbName>
      </DbList>
      <ErrCode>InvalidParameter</ErrCode>
</GetDBListFromAgentReponse>

JSON format

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

Error codes

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