All Products
Search

This Product

    ApsaraDB RDS:TerminateMigrateTask

    Document Center

    ApsaraDB RDS:TerminateMigrateTask

    Last Updated:Sep 13, 2024

    Terminates an ongoing migration task of an ApsaraDB RDS for SQL Server instance.

    Operation description

    Supported database engines

    • SQL Server

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:TerminateMigrateTaskdelete
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

    		rm-bp159vfbu******
    MigrateTaskIdstringYes

    The migration task ID. You can call the DescribeMigrateTasks operation to query the migration task ID.

    		56254****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		1AD222E9-E606-4A42-BF6D-8A4442913CEF

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidTaskType.InvalidMigrate 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.
    400IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    400InvalidTask.NotFoundSpecified MigrateTaskId could not be found on RDS.No migration task ID is found in RDS.
    400InvalidParameter.InvalidSpecified MigrateTaskId is invalid.The value of the MigrateTaskId parameter is invalid.
    400InvalidTaskStatusCurrent task status (Terminated/Failed) does not support.The current task status (Stopped) does not support the operation.
    400UnfinishedTerminateMigrateTaskSpecified MigrateTaskId terminate failed.Failed to stop the migration.

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

    Change history

    Change timeSummary of changesOperation
    No change history