All Products
Search

This Product

    ApsaraDB RDS:DescribeMigrateTaskById

    Document Center

    ApsaraDB RDS:DescribeMigrateTaskById

    Last Updated:May 29, 2023

    Queries a single task that is used to migrate the backup data of an ApsaraDB RDS for SQL Server instance to an Object Storage Service (OSS) bucket.

    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:DescribeMigrateTaskByIdRead
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The operation that you want to perform. Set the value to DescribeMigrateTaskById.

    		rm-bp11e1tzgxxxx4ox
    MigrateTaskIdstringYes

    The ID of the instance.

    		235943
    ResourceGroupIdstringNo

    The time when the migration task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		rg-acfmy*****

    Response parameters

    ParameterTypeDescriptionExample
    object
    Statusstring

    The time when the migration task was completed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		Success
    EndTimestring

    The name of the database.

    		2021-05-30T15:15:05Z
    DBInstanceNamestring

    The ID of the instance.

    		rm-uf6wjk5xxxxxxxxxx
    RequestIdstring

    Indicates whether the imported data overwrites the existing data. Valid values:

    • False: The imported data does not overwrite the existing data.
    • True: The imported data overwrites the existing data.
    		6ED3635A-01F9-47BD-B9C8-CB3FD70A336E
    Descriptionstring

    The ID of the migration task.

    		Success to DBCC checkdb asynchronously
    CreateTimestring

    The description of the migration task.

    		2020-05-30T12:11:04Z
    DBNamestring

    The type of the migration task. Valid values:

    • FULL: The migration task migrates full backup files that can be used to restore the full data of the instance.
    • UPDF: The migration task migrates incremental or log backup files that can be used to restore the incremental data of the instance.
    		mytestdb
    BackupModestring

    The ID of the request.

    		FULL
    MigrateTaskIdstring

    The status of the migration task. Valid values:

    • NoStart: The task has not started.
    • Running:The task is in progress.
    • Success: The task is successful.
    • Failed: The task failed.
    • Waiting: The task is waiting for an incremental backup file to be imported.
    		235943

    Examples

    Sample success responses

    JSONformat

    {
  "Status": "Success",
  "EndTime": "2021-05-30T15:15:05Z",
  "DBInstanceName": "rm-uf6wjk5xxxxxxxxxx",
  "RequestId": "6ED3635A-01F9-47BD-B9C8-CB3FD70A336E",
  "Description": "Success to DBCC checkdb asynchronously",
  "CreateTime": "2020-05-30T12:11:04Z",
  "DBName": "mytestdb",
  "BackupMode": "FULL",
  "MigrateTaskId": "235943",
  "IsDBReplaced": "False"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidStartTimeAndEndTime.MalformedThe end time must be greater than the start time.The operation failed. The end time must be later than the start time. For example, you can set the start time to 2011-05-30 T12:11:20Z and set the end time to 2011-06-08 T12:09:20Z.
    400InvalidMigrateTaskThe specified MigrateTaskId 237360 does not exist. Please check again.The backup data migration task with the 237360 ID cannot be found.
    403InvalidInstanceStateThe DB instance state does not support this operation.The operation failed. The RDS instance is unavailable.

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

    Change history

    Change timeSummary of changesOperation
    2022-08-04The error codes of the API operation change.,The input parameters of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: ResourceGroupId