查询任务列表 - ListSecretTask

功能介绍

查询任务列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
csms::listTasks	List	-	-	csms:task:list	-

URI

GET /v1/{project_id}/csms/tasks

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
secret_name	否	String	凭据的名称。
status	否	String	任务状态。取值： SUCCESS ：任务轮转成功。 FAILED ：任务轮转失败。
task_id	否	String	任务ID。该参数与其他参数不能同时存在。
limit	否	Integer	每页返回的个数。默认值：50。
marker	否	String	分页查询起始的任务ID，为空时为查询第一页。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
total	Integer	任务数量
tasks	Array of SecretTask objects	凭据任务列表。
next_marker	String	下一页查询地址（本页的末尾任务ID）。

表4 SecretTask
参数	参数类型	描述
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	任务错误信息。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码：403

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码：404

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码：500

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码：502

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码：504

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

查询凭据任务，任务ID为xxxxx。
```
/v1/xxxxx/csms/tasks?task_id=xxxxx
```
查询凭据任务，凭据名称为xx，任务状态为FAILED，每页返回个数为10个，分页起始任务ID为xxxx。
```
/v1/xxxxx/csms/tasks?secret_name=xx&status=FAILED&limit=10&marker=xxxx
```

响应示例

状态码：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	请求已成功。
400	请求参数有误
401	被请求的页面需要用户名和密码
403	认证失败
404	资源不存在，资源未找到
500	服务内部错误
502	请求未完成。服务器从上游服务器收到一个无效的响应
504	网关超时