获取文件系统异步任务列表
功能介绍
获取文件系统异步任务列表。仅支持查询目录资源使用情况的任务，API请求路径的feature取值为dir-usage，以下简称为DU任务。
接口约束
在2023年8月1号之后创建的文件系统支持该API操作。后端有5min的缓存时间，查询的数据可能有延迟。API请求路径的feature仅支持以下取值：
-
dir-usage
该接口仅适用于以下类型：
-
20MB/s/TiB
-
40MB/s/TiB
-
125MB/s/TiB
-
250MB/s/TiB
-
500MB/s/TiB
-
1000MB/s/TiB
标准型、标准型-增强版、性能型、性能型-增强版类型 的SFS Turbo文件系统，请使用“查询目录资源使用情况”接口。
URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id |
|
share_id |
是 |
String |
文件系统id |
|
feature |
是 |
String |
任务类型。例，DU任务取值为dir-usage |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
marker |
否 |
String |
marker，取值为task_id |
|
limit |
否 |
Integer |
limit, 取值为正整数. 默认为20，最大值为100 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
账号的token |
|
Content-Type |
是 |
String |
MIME类型, application/json |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
tasks |
Array of OneFsTaskResp objects |
任务列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
任务ID |
|
status |
String |
任务状态, SUCCESS表示成功，DOING表示正在执行，FAIL表示失败 |
|
dir_usage |
FsDuInfo object |
目录资源使用情况(包含子目录) |
|
begin_time |
String |
任务开始时间，UTC时间，例如：2006-01-02 15:04:05' |
|
end_time |
String |
任务结束时间，UTC时间，例如：2006-01-02 15:04:06' |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errCode |
String |
错误码 |
|
errMsg |
String |
错误描述 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errCode |
String |
错误码 |
|
errMsg |
String |
错误描述 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errCode |
String |
错误码 |
|
errMsg |
String |
错误描述 |
请求示例
ID为"77ba6f4b-6365-4895-8dda-bc7142af4dde的文件系统，获取DU任务列表,从任务ID为"11abef677ac40f46644d1d5cfc2424a4"起，获取50个任务
GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/dir-usage/tasks?marker=11abef677ac40f46644d1d5cfc2424a4&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 |
错误响应 |
错误码
请参见错误码。
