Queries the tasks that are created to migrate the backup data of an ApsaraDB RDS for SQL Server instance.
Operation description
Supported database engine
- SQL Server
Usage notes
This operation allows you to query the migration tasks that are created for the instance over the last week.
Precautions
- This operation is supported only for migration tasks that are created to migrate full backup files.
- This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition.
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:DescribeMigrateTasks | get | *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-uf6wjk5xxxxxxx |
| StartTime | string | Yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. | 2017-10-20T01:00Z |
| EndTime | string | Yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. | 2017-10-25T01:00Z |
| PageSize | integer | No | The number of entries to return on each page. Valid values: 30 to 100. Default value: 30. | 30 |
| PageNumber | integer | No | The page number. Valid values: any non-zero positive integer. Default value: 1. | 1 |
| ResourceGroupId | string | No | The resource group ID. | rg-acfmy***** |
Response parameters
Examples
Sample success responses
JSONformat
{
"DBInstanceId": "rm-uf6wjk5xxxxxxx",
"PageNumber": 1,
"RequestId": "4E356DDF-6B83-45DB-99D5-4B1E8A0D286B",
"PageRecordCount": 10,
"TotalRecordCount": 30,
"Items": {
"MigrateTask": [
{
"EndTime": "2017-05-30T13:11:04Z",
"Status": "Success",
"Description": "Api description",
"CreateTime": "2017-05-30T12:11:04Z",
"DBName": "testDB",
"BackupMode": "FULL",
"MigrateTaskId": "564522545",
"IsDBReplaced": "True"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidStartTimeAndEndTime.Malformed | The end time must be greater than the start time | The end time must be later than the start time. |
| 403 | InvalidInstanceState | The 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 time | Summary of changes | Operation |
|---|---|---|
| 2024-11-20 | API Description Update. The Error code has changed | View Change Details |
| 2022-08-04 | The Error code has changed. The request parameters of the API has changed | View Change Details |