GetDBListFromAgent API Reference for Backup Gateway - Data Management - Alibaba Cloud - Data Management

Operation description

Call the CreateGetDBListFromAgentTask operation to create an asynchronous task and obtain the TaskId. Then, pass the TaskId to the GetDBListFromAgent operation to retrieve the database and table data from the physical backup.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:GetDBListFromAgent

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackupGatewayId	integer	No	The ID of the backup gateway. You can call the DescribeBackupGatewayList operation to obtain this parameter. Note This parameter is required.	160***
SourceEndpointRegion	string	No	The region ID of the backup gateway.	cn-hangzhou
TaskId	integer	No	The ID of the asynchronous task. You can call the CreateGetDBListFromAgentTask operation to obtain this parameter.	123456
ClientToken	string	No	The client token that is used to ensure the idempotence of the request to prevent repeated submissions. The value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.	ETnLKlblzczshOTUbOCzxxxxxxxxxx

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	400
RequestId	string	The request ID.	EB4DFD5E-3618-498D-BE35-4DBEA0072122
ErrCode	string	The error code.	InvalidParameter
Success	boolean	Indicates whether the request was successful.	true
ErrMessage	string	The error message.	This backupPlan can't support this action
DbList	object
dbName	array	The database list.
	string	The database list.	TaskDB

Examples

Success response

JSON format

{
  "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

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.