# 获取指定实例和时间范围的任务信息（SQL Server） - ListJobInfoDetail #### 功能介绍 获取SQL Server指定实例ID、指定时间范围的任务信息列表。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=ListJobInfoDetail)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:task:listAll | read | - | - | - | - | #### 接口约束 - 该接口只可查询任务中心一个月内的异步任务。 - 目前支持查询的主要异步任务：创建实例(单实例/主备实例)、创建只读实例、单实例转主备实例、主备切换、磁盘扩容，自动备份，手动备份，恢复到新实例，恢复到当前实例，恢复到已有实例。 #### URI - URI格式 GET /v3/{project_id}/instances/{instance_id}/tasklist/detail?start_time={start_time}\&end_time={end_time} - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"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 | **参数解释**： 任务总数。 **取值范围**： 不涉及。 | 表3jobs字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | 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 | **参数解释**： 根据不同的任务，显示不同的内容。 请参见如下各表： - [表5] - [表6] 说明： 未有task_detail字段说明的异步任务，该字段不显示。 | | fail_reason | String | **参数解释**： 任务执行失败时的错误信息。 **取值范围**： 不涉及。 | | entities | Object | **参数解释**： 根据不同的任务，显示不同的内容。 **取值范围**： 不涉及。 | 表4instance字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 实例名称。 **取值范围**： 不涉及。 | 表5task_detail字段数据结构说明（恢复到新实例，恢复到当前实例，恢复到已有实例，表级时间点恢复） | 名称 | 参数类型 | 说明 | |:---|:---|:---| | sourceInstanceId | String | **参数解释**： 备份恢复的源实例ID。 **取值范围**： 不涉及。 | | targetInstanceId | String | **参数解释**： 恢复备份的目标实例ID。 **取值范围**： 不涉及。 | | backupId | String | **参数解释**： 备份文件ID。 **取值范围**： 不涉及。 | | restoreTime | String | **参数解释**： 表级时间点恢复的恢复时间。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 任务类型。 **取值范围**： 不涉及。 | | dbNames | List\ | **参数解释**： 数据库名称。 **取值范围**： 不涉及。 | 表6task_detail字段数据结构说明(自动备份，手动备份) | 名称 | 参数类型 | 说明 | |:---|:---|:---| | instanceId | String | **参数解释**： 进行备份的实例ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 任务名称。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 任务描述。 **取值范围**： 不涉及。 | | dbNames | String | **参数解释**： 备份的数据库名称。 **取值范围**： 不涉及。 | ![](https://support.huaweicloud.com/api-rds/public_sys-resources/note_3.0-zh-cn.png) 响应样例中取返回结果部分任务详情作为示例。 - 正常响应样例 **自动备份，手动备份：** ``` { "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 } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。