# 查询任务列表 - ListSecretTask #### 功能介绍 查询任务列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dew/dew_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dew/dew_02_0308.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | csms::listTasks | List | - | - | csms:task:list | - | #### URI GET /v1/{project_id}/csms/tasks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考[获取项目ID](https://support.huaweicloud.com/api-dew/dew_02_0009.html)获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | secret_name | 否 | String | **参数解释：** 凭据名称 **约束限制：** 不涉及 **取值范围：** 需要满足正则表达式：\^\[a-zA-Z0-9_-\]{1,64}$ **默认取值：** 不涉及 | | status | 否 | String | **参数解释：** 任务状态 **约束限制：** - SUCCESS ：任务轮转成功 - FAILED ：任务轮转失败 **取值范围：** 不涉及 **默认取值：** 不涉及 | | task_id | 否 | String | **参数解释：** 任务ID **约束限制：** 该参数与其他参数不能同时存在 **取值范围：** 不涉及 **默认取值：** 不涉及 | | limit | 否 | Integer | **参数解释：** 每页返回的个数 **约束限制：** 每页默认返回50，最多1000条数据 **取值范围：** 不涉及 **默认取值：** 不涉及 | | marker | 否 | String | **参数解释：** 以单页最后一条任务ID作为分页标记。为空时为查询第一页 **约束限制：** marker需要和limit配合使用，不能独立使用。当最后一页返回数量小于limit时，表示查询结束 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释：** 任务总数 **取值范围：** 不涉及 | | tasks | Array of [SecretTask] objects | **参数解释：** 凭据任务列表 **取值范围：** 不涉及 | | next_marker | String | **参数解释：** 下一页查询地址（本页的末尾任务ID） **取值范围：** 不涉及 | 表5SecretTask | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | **参数解释：** 任务ID **取值范围：** 不涉及 | | secret_name | String | **参数解释：** 凭据名称 **取值范围：** 不涉及 | | rotation_func_urn | String | **参数解释：** FunctionGraph函数的urn **取值范围：** 不涉及 | | task_status | String | **参数解释：** 任务状态 **取值范围：** 不涉及 | | operate_type | String | **参数解释：** 轮转类型 **取值范围：** 不涉及 | | task_time | Long | **参数解释：** 任务创建时间 **取值范围：** 不涉及 | | attempt_nums | Integer | **参数解释：** 任务尝试次数 **取值范围：** 不涉及 | | task_error_code | String | **参数解释：** 任务错误码 **取值范围：** 不涉及 | | task_error_msg | String | **参数解释：** 任务错误信息 **取值范围：** 不涉及 | #### 请求示例 - 查询凭据任务，任务ID为fff921f3-58bd-4fe7-9dfd-3d8bb2a982fe ``` /v1/604b5be0e59c47b08c64f9cd9add5625/csms/tasks?task_id=fff921f3-58bd-4fe7-9dfd-3d8bb2a982fe ``` - 查询凭据任务，凭据名称为test_secret，任务状态为FAILED，每页返回个数为10个，分页起始任务ID为fff921f3-58bd-4fe7-9dfd-3d8bb2a982fe ``` /v1/604b5be0e59c47b08c64f9cd9add5625/csms/tasks?secret_name=test_secret&status=FAILED&limit=10&marker=fff921f3-58bd-4fe7-9dfd-3d8bb2a982fe ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "total" : 1, "tasks" : [ { "task_id" : "xxxx", "secret_name" : "xxxx", "rotation_func_urn" : "urn:fss:cn-north-4:xxxxxxxx:function:default:xxxx:xxxxx", "task_status" : "SUCCESS", "attempt_nums" : 3, "operate_type" : "MULTI_USER", "task_time" : 1715436899000 } ], "next_marker" : "xxxxxx" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dew/ErrorCode.html)。