All Products
Search
Document Center

Database Backup:GetDBListFromAgent

Last Updated:Mar 03, 2024

Queries the result of a task that is used to query a database list by using a backup gateway based on the ID of the task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dbs:GetDBListFromAgentRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupGatewayIdlongNo

The ID of the backup gateway.

160813
SourceEndpointRegionstringNo

The region in which the backup gateway resides.

cn-hangzhou
TaskIdlongNo

The ID of the asynchronous task.

123456
ClientTokenstringNo

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

ETnLKlblzczshOTUbOCzxxxxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

400
RequestIdstring

The ID of the request.

EB4DFD5E-3618-498D-BE35-4DBEA0072122
ErrCodestring

The error code.

InvalidParameter
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

This backupPlan can't support this action
DbListarray

The details of the databases.

string

The details of the databases.

TaskDB

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history