CreateGetDBListFromAgentTask - Data Management - Alibaba Cloud Documentation Center

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.

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:CreateGetDBListFromAgentTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackupGatewayId	integer	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.XX.XX
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 elements

Element	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	integer	The ID of the asynchronous task.	123456

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

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.