Obtaining Task Information of a Specified DB Instance in a Specified Time Range (RDS for SQL Server)

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.
Before calling this API, learn about request header parameters.

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** Parameters
Parameter	Mandatory	Description
project_id	Yes	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	Yes	Explanation: Instance ID. Constraints: N/A Value range: N/A Default value: N/A
start_time	Yes	Explanation: Start time in the UTC timestamp format. Constraints: N/A Value range: N/A Default value: N/A
end_time	No	Explanation: End time in the UTC timestamp format. Constraints: N/A Value range: N/A Default value: N/A

Request

Request parameters
None
URI example
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/a48e43ff268f4c0e879652d65e63d0fbin01/tasklist/detail?start_time=1533423274000&end_time=1533823274000

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
jobs	Object	Explanation: Indicates the task information. For details, see Table 3.
count	Integer	Explanation: Indicates the total number of tasks. Value range: N/A

**Table 3** jobs field data structure description
Parameter	Type	Description
id	String	Explanation: Indicates the task ID. Value range: N/A
name	String	Explanation: Indicates the task name. Value range: N/A
status	String	Explanation: Indicates the task execution status. Value range: Running: The task is being executed. Completed: The task is successfully executed. Failed: The task fails to be executed.
created	String	Explanation: Indicates the creation time. Value range: The value is 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.
process	String	Explanation: Indicates the task execution progress. Value range: 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	Explanation: Indicates information of the DB instance on which the task is executed. For details, see Table 4.
task_detail	String	Explanation: The displayed information varies depending on the tasks. For details, see the following: Table 5 Table 6 NOTE: This field is not displayed for asynchronous tasks that do not contain the task_detail field.
fail_reason	String	Explanation: Indicates the error information displayed when a task failed. Value range: N/A
entities	Object	Explanation: The displayed information varies depending on the tasks. Value range: N/A

**Table 4** instance field data structure description
Parameter	Type	Description
id	String	Explanation: Indicates the DB instance ID. Value range: N/A
name	String	Explanation: Indicates the DB instance name. Value range: N/A

**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)
Parameter	Type	Description
sourceInstanceId	String	Explanation: Indicates the ID of the original DB instance to which backup data is restored. Value range: N/A
targetInstanceId	String	Explanation: Indicates the ID of the target DB instance to which backup data is restored. Value range: N/A
backupId	String	Explanation: Indicates the backup file ID. Value range: N/A
restoreTime	String	Explanation: Indicates the time point to which table-level data is restored. Value range: N/A
type	String	Explanation: Indicates the task type. Value range: N/A
dbNames	List<String>	Explanation: Indicates the database name. Value range: N/A

**Table 6** task_detail field data structure description (creating automated or manual backups)
Parameter	Type	Description
instanceId	String	Explanation: Indicates the ID of the DB instance to be backed up. Value range: N/A
name	String	Explanation: Indicates the task name. Value range: N/A
description	String	Explanation: Indicates the task description. Value range: N/A
dbNames	String	Explanation: Indicates the name of the data to be backed up. Value range: N/A

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
}