# 查询任务列表和详情 - QueryingTasksandDetails #### 功能介绍 查询任务列表和详情，默认查询任务列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ListJobs)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:task:list | List | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId | nosql:task:list | - | #### URI GET /v3/{project_id}/jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释：** 任务ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | start_time | 否 | String | **参数解释：** 查询开始时间。 **约束限制：** 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始，Z指时区偏移量。 **取值范围：** 不涉及。 **默认取值：** 默认当前时间往前30天。 | | end_time | 否 | String | **参数解释：** 查询结束时间。 **约束限制：** 格式为"yyyy-mm-ddThh:mm:ssZ"，且大于查询开始时间，时间跨度不超过30天。 其中，T指某个时间的开始，Z指时区偏移量。 **取值范围：** 不涉及。 **默认取值：** 默认当前时间。 | | status | 否 | String | **参数解释：** 任务状态。 **约束限制：** 不涉及。 **取值范围：** - Running：表示任务正在执行。 - Completed：表示任务执行成功。 - Failed：表示任务执行失败。 **默认取值：** 不涉及。 | | name | 否 | String | **参数解释：** 任务名称。 **约束限制：** 不涉及。 **取值范围：** - CreateInstance：创建实例。 - RestoreNewInstance：恢复到新实例。 - EnlargeInstance：扩容实例。 - ReduceInstance：缩容实例。 - RestartInstance：重启实例。 - RestartNode：重启节点。 - EnlargeInstanceVolume：扩容实例磁盘。 - ReduceInstanceVolume：缩容实例磁盘。 - ResizeInstance：规格变更实例。 - UpgradeDbVersion：升级数据库版本。 - BindPublicIP：绑定公网IP。 - UnbindPublicIP：解绑公网IP。 - DeleteInstance：删除实例。 - EnlargeInstanceColdVolume：扩容实例冷存储。 - AddInstanceColdVolume：增加实例冷存储。 - ModifySecurityGroup：修改安全组。 - ModifyCcmCert：修改CCM证书。 - ModifyPort：修改端口。 - ConstructDisasterRecovery：构造容灾关系。 - DeConstructDisasterRecovery：解除容灾关系。 - SwitchOverDisasterRecovery：切换容灾关系。 - BuildBiActiveInstance：构建双活实例。 - ReleaseBiActiveInstance：解除双活实例关系。 - BackupInstance：备份实例。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。 **约束限制：** 必须为数字，不能为负数。 **取值范围：** 不涉及。 **默认取值：** 默认为0，偏移0条数据，表示从第一条数据开始查询。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 必须为数字，不能为负数。 **取值范围：** - 10。 - 20。 - 50。 **默认取值：** 默认为50。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | jobs | Array of [表5] objects | **参数解释：** 任务列表。 | | total_count | Integer | **参数解释：** 任务列表总数。 **取值范围：** 不涉及。 | 表5JobDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 任务名称。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 任务执行状态。 **取值范围：** - Running：表示任务正在执行。 - Completed：表示任务执行成功。 - Failed：表示任务执行失败。 | | start_time | String | **参数解释：** 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | end_time | String | **参数解释：** 结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | progress | String | **参数解释：** 任务执行进度。执行中状态才返回执行进度，例如"60%"表示任务执行进度为60%，否则返回""。 **取值范围：** 不涉及。 | | instance | [表6] object | **参数解释：** 任务关联的实例信息。 | | fail_reason | String | **参数解释：** 任务执行失败时的错误信息。 **取值范围：** 不涉及。 | 表6JobInstanceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | #### 请求示例 URI样例 ``` GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/jobs?id=89a0cde6-9c46-4b89-a92c-573e1083ff23 ``` #### 响应示例 **状态码： 200** Success ``` { "total_count" : 1, "jobs" : [ { "id" : "6f85e061-04dd-42e7-86d6-d3b1e40aac2e", "name" : "CreateCassandra", "status" : "Running", "start_time" : "2023-09-12T06:44:01+0000", "end_time" : "2023-09-12T06:44:03+0000", "progress" : "14%", "instance" : { "id" : "27a045b6bf9e46f691f81366d398cb04in06", "name" : "nosql-12f5" }, "fail_reason" : "" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。