ListImportTasks-阿里云帮助中心

Operation description

Lists the data import tasks for native replication on a specified instance.

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

rds:ListImportTasks

list

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
DBInstanceId	string	Yes	The instance ID. You can call the `DescribeDBInstances` operation to query instance IDs.	rm-uf6wjk5****
MaxResults	integer	No	The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 30. Note If you specify this parameter, you cannot use the PageSize and PageNumber parameters.	30
NextToken	string	No	The pagination cursor. It is used to retrieve the next page of results.	AAAAAdDWBF2

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC
Items	array<object>	The details of the data import tasks.
	object	Details of a data import task.
TaskId	integer	The task ID.	342900000
TaskName	string	The task name.	362c6c7a-4d20-4eac-898c-1495ceab374c
CreatedTime	string	The UTC time when the task was created, in YYYY-MM-DDTHH:mm:ssZ format.	2018-05-30T14:30:00Z
Status	string	The task status.	Importing
DbVersion	string	The kernel version.	5.7
TaskType	string	The task type.	import
TargetInstanceName	string	The target instance ID.	rm-bp*****
NextToken	string	The pagination cursor to use in the next request to retrieve the next page of results. If this parameter is not returned, it indicates that all results have been returned.	None
MaxResults	integer	The maximum number of entries returned per page. Note	30

Examples

Success response

JSON format

{
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
  "Items": [
    {
      "TaskId": 342900000,
      "TaskName": "362c6c7a-4d20-4eac-898c-1495ceab374c",
      "CreatedTime": "2018-05-30T14:30:00Z",
      "Status": "Importing",
      "DbVersion": "5.7",
      "TaskType": "import",
      "TargetInstanceName": "rm-bp*****"
    }
  ],
  "NextToken": "None",
  "MaxResults": 30
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	The operation failed. The RDS instance is not in a ready state.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.