Queries restore tasks.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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 keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
| Operate | access level | Resource type | conditional keyword | Association operation |
|---|---|---|---|---|
| dbs:DescribeRestoreTaskList | Read |
|
| without |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| BackupPlanId | string | No | The ID of the backup schedule. | dbs1hvb0wwwXXXXX |
| RestoreTaskId | string | No | The ID of the restore task. You can query multiple restore tasks. Separate multiple IDs with commas (,). You can call the CreateRestoreTask operation to obtain the ID of the restore task. NoteYou can set either the RestoreTaskId parameter or the BackupPlanId parameter. If both parameters are set, an error occurs. | s102h7rf5anq |
| PageSize | integer | No | The number of entries to return on each page. Valid values:
NoteDefault value: 30. | 30 |
| PageNum | integer | No | The number of the page to return. The value must be a positive integer. Default value: 0. | 1 |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. | ETnLKlblzczshOTUbOCzxxxxxxx |
| StartTimestamp | long | No | The beginning of the time range to query. | 1570701361528 |
| EndTimestamp | long | No | The end of the time range to query. | 1570701361528 |
Response parameters
Example
Normal return example
JSONFormat
{
"HttpStatusCode": 200,
"PageNum": 1,
"RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid. ",
"TotalPages": 1,
"TotalElements": 1,
"PageSize": 30,
"Items": [
{
"RestoreStatus": "running",
"FullStruAfterRestoreProgress": 100,
"CrossRoleName": "test123",
"RestoreDir": "100.X.X.10:33204",
"CrossAliyunId": "2xxx7778xxxxxxxxxx",
"RestoreObjects": "[ { \\\"DBName\\\":\\\"test\\\" } ]",
"BackupPlanId": "dbs1hvb0wXXXX",
"DestinationEndpointRegion": "cn-hangzhou",
"RestoreTaskCreateTime": 1554560477000,
"DestinationEndpointUserName": "test",
"RestoreTaskFinishTime": 1554560477000,
"DestinationEndpointIpPort": "100.X.X.10:33204",
"DestinationEndpointDatabaseName": "test",
"DestinationEndpointInstanceType": "RDS",
"DestinationEndpointOracleSID": "test",
"FullStruforeRestoreProgress": 0,
"ErrMessage": "NULL",
"RestoreTaskId": "s1XXXXXX",
"FullDataRestoreProgress": 100,
"ContinuousRestoreProgress": 100,
"DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
"BackupSetId": "1ibh2f5uXXX",
"BackupGatewayId": 324234332,
"RestoreTaskName": "test",
"RestoreTime": 1554560477000
}
]
}Error codes
For a list of error codes, visit the API error center.