Obtaining Task Information of a Specified SQL Server DB Instance in a Specified Time Range
Function
This API is used to obtain the task information list of a specified SQL Server DB instance ID within a specified time range.
- Before calling an API, you need to understand the API in Authentication.
Constraints
- This API is used to query asynchronous tasks of the last one month in the task center.
- Information of the following asynchronous tasks can be obtained: creating single or primary/standby DB instances, creating read replicas, changing single DB instances to primary/standby instances, switching primary/standby DB instances, scaling up storage space, creating automated or manual backups, restoring data to original, existing, or new DB instances.
URI
- URI format
GET /v3/{project_id}/instances/{instance_id}/tasklist/detail?start_time={start_time}&end_time={end_time}
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
Yes
Specifies the DB instance ID.
start_time
Yes
Specifies the start time in the UTC timestamp format.
end_time
No
Specifies the end time in the UTC timestamp format.
Request
Response
- Normal response
Table 2 Parameter description Name
Type
Description
jobs
Object
Indicates the task information. For details, see Table 3.
count
Integer
Indicates the total number of tasks.
Table 3 jobs field data structure description Name
Type
Description
id
String
Indicates the task ID.
name
String
Indicates the task name.
status
String
Indicates the task execution status.
Value:- Running: The task is being executed.
- Completed: The task is successfully executed.
- Failed: The task fails to be executed.
created
String
Indicates the creation time in the "yyyy-mm-ddThh:mm:ssZ" format.
T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.
ended
String
Indicates the end time in the "yyyy-mm-ddThh:mm:ssZ" format.
T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.
process
String
Indicates the task execution progress.
NOTE:The execution progress (such as "60", indicating the task execution progress is 60%) is displayed only when the task is being executed. Otherwise, "" is returned.
instance
Object
Indicates information of the DB instance on which the task is executed.
For details, see Table 4.
task_detail
String
The displayed information varies depending on the tasks.
For details, see the following:
NOTE:This field is not displayed for asynchronous tasks that do not contain the task_detail field.
fail_reason
String
Indicates the error information displayed when a task failed.
entities
Object
The displayed information varies depending on the tasks.
Table 4 instance field data structure description Name
Type
Description
id
String
Indicates the DB instance ID.
name
String
Indicates the DB instance name.
Table 5 task_detail field data structure description (restoring data to original, existing, or new DB instances, or restoring table-level data to a specified time point) Name
Type
Description
sourceInstanceId
String
Indicates the ID of the original DB instance to which backup data is restored.
targetInstanceId
String
Indicates the ID of the target DB instance to which backup data is restored.
backupId
String
Indicates the backup file ID.
restoreTime
String
Indicates the time point to which table-level data is restored.
type
String
Indicates the task type.
dbNames
List<String>
Indicates the database name.
Table 6 task_detail field data structure description (creating automated or manual backups) Name
Type
Description
instanceId
String
Indicates the ID of the DB instance to be backed up.
name
String
Indicates the task name.
description
String
Indicates the task description.
dbNames
String
Indicates the name of the data to be backed up.
In the response example, some returned task details are used as examples.
- Example normal response
Creating automated or manual backups:
{ "jobs": [ { "id": "aa4e3386-af27-436e-99f5-7cfefa21c37a", "name": "BackupDbSqlserverInInstance", "status": "Completed", "created": "2020-07-20T16:10:07+0000", "ended": "2020-07-20T16:14:39+0000", "process": "", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" }, "task_detail": "{\"instanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\",\"name\":\"sqlserver-rds-8d43-0004-20200719161130675\"}" } ], "count":1 }
Restoring data to original, existing, or new DB instances, or restoring table-level data to a specified time point:{ "jobs": [ { "id": "11bef2cb-2924-4727-a9c2-b6fec61fc03a", "name": "SingleDbRestoreSqlserverInInstance", "status": "Failed", "created": "2020-07-21T01:38:00+0000", "ended": "2020-07-21T01:39:59+0000", "process": "", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" }, "task_detail": "{\"backupId\":\"83c76e6852c145779dc153d8299ee0e1br04\",\"dbNames\":\"backeeeeee\",\"sourceInstanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\",\"targetInstanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\"}" } ], "count":1 }
Other task types:{ "jobs":[ { "id":"11bef2cb-2924-4727-a9c2-b6fec61fc03a", "name":"SingleDbRestoreSqlserverInInstance", "status":"Complete", "created":"2020-07-21T01:38:00+0000", "ended":"2020-07-21T01:39:59+0000", "process":"", "instance":{ "id":"9a09052dfa824caea36f583bc3e5684ein04", "name":"rds-8d43-0004" } } ], "count":1 }
Task being executed:{ "jobs":[ { "id": "32291a2e-882b-4266-b7c0-89dae34d2a9d", "name": "CreateSqlserverSingleHAInstance", "status": "Running", "created": "2020-07-14T15:02:29+0000", "ended": "2020-07-14T15:16:18+0000", "process": "50", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" } } ], "count":1 }
Task fails to be executed:{ "jobs":[ { "id": "32291a2e-882b-4266-b7c0-89dae34d2a9d", "name": "CreateSqlserverSingleHAInstance", "status": "Failed", "created": "2020-07-14T15:02:29+0000", "ended": "2020-07-14T15:16:18+0000", "process": "", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" }, "fail_reason": "createVM failed." } ], "count":1 }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot