ValidateImportTask-阿里云帮助中心

Pre-checks a data import task on an RDS for MySQL native replication instance.

Operation description

Pre-checks a data import task on an RDS for MySQL native replication 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:ValidateImportTask

none

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the `DescribeRegions` operation to query the most recent list of regions.	cn-hangzhou
Host	string	Yes	The address of the source MySQL instance.	192.168.10.1
Port	integer	Yes	The port number of the source MySQL instance.	3306
StreamPort	integer	Yes	The port used for backup data transfer.	9999
User	string	Yes	The username for the source MySQL user account.	myadmin
Password	string	Yes	The password for the source MySQL user account. The password must be Base64-encoded.	UGFzc3dvcmQxMjMK
SourcePlatform	string	No	The type of the source. ECS	ECS
SourceInstanceId	string	No	The ID of the source cloud instance.	i-wz9ff3acy500io5wdf5s
XtrabackupPath	string	No	The path to the Xtrabackup tool on the source instance.	/usr/local/bin/xtrabackup
DbInstanceId	string	Yes	The instance ID. You can call the `DescribeDBInstances` operation to query the instance details.	rm-sdfljk123****
EstimatedSize	integer	No	The estimated size of the instance, in GB.	100

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	08A3B71B-FE08-4B03-974F-CC7EA6DB1828
TaskId	integer	The ID of the pre-check task.	12345

Examples

Success response

JSON format

{
  "RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828\t",
  "TaskId": 12345
}

Error codes

HTTP status code	Error code	Error message	Description
400	INVALID_SOURCE_INSTANCE.RDS_CUSTOM	Source RdsCustom instance is not valid to import, please check instance attributes.	The source RdsCustom instance cannot be used for RDS data import. Check the instance properties.
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.