文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 获取任务信息/ 获取指定实例和时间范围的任务信息（SQL Server）
更新时间：2024-03-28 GMT+08:00
查看PDF
分享

获取指定实例和时间范围的任务信息（SQL Server）

功能介绍

获取SQL Server指定实例ID、指定时间范围的任务信息列表。

接口约束

  • 该接口只可查询任务中心一个月内的异步任务。
  • 目前支持查询的主要异步任务：创建实例(单实例/主备实例)、创建只读实例、单实例转主备实例、主备切换、磁盘扩容，自动备份，手动备份，恢复到新实例，恢复到当前实例，恢复到已有实例。

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/tasklist/detail?start_time={start_time}&end_time={end_time}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID。

    instance_id

    是

    实例ID。

    start_time

    是

    开始时间，格式为UTC时间戳。

    end_time

    否

    结束时间，格式为UTC时间戳。

请求消息

  • 请求参数

    无。

  • URI样例

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

响应消息

  • 正常响应要素说明
    表2 参数说明

    名称

    参数类型

    说明

    jobs

    Object

    任务信息，请参见表3。

    count

    Integer

    任务总数。
    表3 jobs字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    任务ID。

    name

    String

    任务名称。

    status

    String

    任务执行状态。

    取值：
    • 值为“Running”，表示任务正在执行。
    • 值为“Completed”，表示任务执行成功。
    • 值为“Failed”，表示任务执行失败。

    created

    String

    创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

    ended

    String

    结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

    process

    String

    任务执行进度。

    说明：

    执行中状态才返回执行进度，例如“60”，表示任务执行进度为60%，否则返回“”。

    instance

    Object

    执行任务的实例信息。

    请参见表4。

    task_detail

    String

    根据不同的任务，显示不同的内容。

    请参见如下各表：

    说明：

    未有task_detail字段说明的异步任务，该字段不显示。

    fail_reason

    String

    任务执行失败时的错误信息。

    entities

    Object

    根据不同的任务，显示不同的内容。
    表4 instance字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    实例ID。

    name

    String

    实例名称。
    表5 task_detail字段数据结构说明（恢复到新实例，恢复到当前实例，恢复到已有实例，表级时间点恢复）

    名称

    参数类型

    说明

    sourceInstanceId

    String

    备份恢复的源实例ID。

    targetInstanceId

    String

    恢复备份的目标实例ID。

    backupId

    String

    备份文件ID。

    restoreTime

    String

    表级时间点恢复的恢复时间。

    type

    String

    任务类型。

    dbNames

    List<String>

    数据库库名称。
    表6 task_detail字段数据结构说明(自动备份，手动备份)

    名称

    参数类型

    说明

    instanceId

    String

    进行备份的实例ID。

    name

    String

    任务名称。

    description

    String

    任务描述。

    dbNames

    String

    备份的数据名称。

    响应样例中取返回结果部分任务详情作为示例。

  • 正常响应样例

    自动备份，手动备份：

    {
  "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
}
    恢复到新实例，恢复到当前实例，恢复到已有实例，表级时间点恢复： 
    {
  "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
}
    其他任务类型： 
    {
    "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
}
    任务正在执行中： 
    {
    "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
}
    任务执行失败： 
    {
    "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
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 获取任务信息