Terminates an ongoing migration task of an ApsaraDB RDS for SQL Server instance.
Operation description
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| rds:TerminateMigrateTask | delete | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-bp159vfbu****** |
| MigrateTaskId | string | Yes | The migration task ID. You can call the DescribeMigrateTasks operation to query the migration task ID. | 56254**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidTaskType.Invalid | Migrate task type Incremental is not supported, only support FULL backup migrate task. | The incremental migration task type is not supported. Only complete backup migration task is supported. |
| 400 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | The operation failed. The RDS instance is not in a ready state. |
| 400 | InvalidTask.NotFound | Specified MigrateTaskId could not be found on RDS. | No migration task ID is found in RDS. |
| 400 | InvalidParameter.Invalid | Specified MigrateTaskId is invalid. | The value of the MigrateTaskId parameter is invalid. |
| 400 | InvalidTaskStatus | Current task status (Terminated/Failed) does not support. | The current task status (Stopped) does not support the operation. |
| 400 | UnfinishedTerminateMigrateTask | Specified MigrateTaskId terminate failed. | Failed to stop the migration. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-12 | API Description Update. The Error code has changed | View Change Details |