CreateGetDBListFromAgentTask - Database Backup - Alibaba Cloud Documentation Center

Creates a task to obtain a database list by using a backup gateway.

Operation description

This API operation returns a task ID. You can call the GetDBListFromAgent operation to query the task result based on the task ID.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dbs:CreateGetDBListFromAgentTask	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupGatewayId	long	No	The ID of the backup gateway. You can call the DescribeBackupPlanList operation to query the ID. Note This parameter is required.	160813
DatabaseType	string	No	The type of the database. Valid values: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis	MySQL
SourceEndpointRegion	string	No	The region in which the backup gateway resides.	cn-hangzhou
SourceEndpointIP	string	No	The URL that is used to access the database.	123.0.0.1
SourceEndpointPort	integer	No	The port that is used to connect to the database.	3306
ClientToken	string	No	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

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code returned.	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
TaskId	long	The ID of the asynchronous task.	123456

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",
  "TaskId": 123456
}

Error codes

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

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

Change history

Change time	Summary of changes	Operation

No change history