获取文件系统异步任务列表 - ListFsTasks
功能介绍
获取文件系统异步任务列表。仅支持查询目录资源使用情况的任务,API请求路径的feature取值为dir-usage,以下简称为DU任务。
接口约束
在2023年8月1号之后创建的文件系统支持该API操作。后端有5min的缓存时间,查询的数据可能有延迟。API请求路径的feature仅支持以下取值:
该接口仅适用于以下类型:
标准型、标准型-增强版、性能型、性能型-增强版类型的SFS Turbo文件系统,请使用“查询目录资源使用情况”接口。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| share_id | 是 | String | 参数解释: 文件系统ID,用于唯一标识SFS Turbo文件系统实例。获取方法请参见1.4 获取文件系统列表 - ListShares。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| feature | 是 | String | 参数解释: 任务类型标识,用于指定要查询的异步任务类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| marker | 否 | String | 参数解释: 分页查询的起始位置标识,填写为上一页返回的最后一条记录的task_id,作为下一次分页查询的起始值。 例如:marker为d651ea2b-2b20-4c6d-8bbf-2adcec18dac9,limit为100,表示从该task_id之后返回最多100条满足查询条件的记录。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 分页查询时每页返回的任务数量。 约束限制: 不涉及。 取值范围: 正整数,取值范围为1~2000。 默认取值: 20 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| tasks | Array of OneFsTaskResp objects | 参数解释: 任务列表,包含当前页的所有异步任务详情。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID,用于唯一标识一个异步任务。 取值范围: 不涉及。 |
| status | String | 参数解释: 任务当前的执行状态。 取值范围: |
| dir_usage | FsDuInfo object | 参数解释: 目录资源使用情况,包含目标目录及其子目录的容量和文件统计信息。仅当任务状态为SUCCESS时返回有效数据。 取值范围: 不涉及。 |
| begin_time | String | 参数解释: 任务开始执行时间。 采用UTC时间,格式为yyyy-mm-dd hh:mm:ss,例如2016-01-02 15:04:05。 取值范围: 不涉及。 |
| end_time | String | 参数解释: 任务结束执行时间。 采用UTC时间,格式为yyyy-mm-dd hh:mm:ss,例如2016-01-02 15:04:05。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| path | String | 参数解释: 文件系统内合法的目录全路径。 取值范围: 不涉及。 |
| used_capacity | Long | 参数解释: 目录及其子目录已占用的存储容量。 取值范围: 非负整数,单位为byte。 |
| file_count | FsFileCount object | 参数解释: 目录下各类文件的数目统计。 取值范围: 不涉及。 |
| message | String | 参数解释: 任务执行过程中的错误信息。任务成功时为空字符串,任务失败时包含错误原因描述。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| dir | Long | 参数解释: 子目录的数目。 取值范围: 不涉及。 |
| regular | Long | 参数解释: 普通文件的数目。 取值范围: 不涉及。 |
| pipe | Long | 参数解释: 管道文件的数目。 取值范围: 不涉及。 |
| char | Long | 参数解释: 字符设备文件的数目。 取值范围: 不涉及。 |
| block | Long | 参数解释: 块设备文件的数目。 取值范围: 不涉及。 |
| socket | Long | 参数解释: 套接字文件的数目。 取值范围: 不涉及。 |
| symlink | Long | 参数解释: 符号链接文件的数目。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 参数解释: 错误码,用于标识请求失败的原因。详细错误码请参见错误码。 取值范围: 不涉及。 |
| errMsg | String | 参数解释: 错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 参数解释: 错误码,用于标识请求失败的原因。详细错误码请参见错误码。 取值范围: 不涉及。 |
| errMsg | String | 参数解释: 错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
请求示例
ID为“77ba6f4b-6365-4895-8dda-bc7142af4dde”的文件系统,获取DU任务列表,从任务ID为“11abef67-7ac4-0f46-644d-1d5cfc2424a4”起,获取50个任务。
GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/dir-usage/tasks?marker=11abef67-7ac4-0f46-644d-1d5cfc2424a4&limit=50 响应示例
状态码:200
{
"tasks" : [ {
"task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
"status" : "SUCCESS",
"dir_usage" : {
"path" : "/path",
"used_capacity" : 0,
"file_count" : {
"dir" : 0,
"regular" : 0,
"pipe" : 0,
"char" : 0,
"block" : 0,
"socket" : 0,
"symlink" : 0
},
"message" : ""
},
"begin_time" : "2023-03-01 11:46:01",
"end_time" : "2023-03-01 11:46:01"
} ]
} 状态码:400
{
"errCode" : "SFS.TURBO.0123",
"errMsg" : "feature invalid"
} 状态码:404
{
"errCode" : "SFS.TURBO.0124",
"errMsg" : "task_id not found"
} 状态码:500
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 错误响应 |
| 404 | 错误响应 |
| 500 | 错误响应 |
错误码
请参见错误码。