更新时间:2024-11-18 GMT+08:00
分享

创建文件系统异步任务

功能介绍

创建文件系统异步任务,仅支持异步查询目录资源使用情况,API请求路径的feature取值为dir-usage,以下简称为DU任务。

接口约束

在2023年8月1号之后创建的文件系统支持该API操作。如果存在10个正在执行的任务,则不允许创建新任务。该接口并发请求数过大可能会影响文件系统性能,建议同时提交的查询请求不要超过4 个。查询超大目录耗时较久,请不要重复提交。API请求路径的feature仅支持以下取值:

  • dir-usage

该接口仅适用于以下类型:

  • 20MB/s/TiB

  • 40MB/s/TiB

  • 125MB/s/TiB

  • 250MB/s/TiB

  • 500MB/s/TiB

  • 1000MB/s/TiB

  • HPC缓存型文件系统

标准型、标准型-增强版、性能型、性能型-增强版类型的SFS Turbo文件系统,请使用“查询目录资源使用情况”接口。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id

share_id

String

文件系统id

feature

String

任务类型。当前仅支持取值"dir-usage"。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

账号的token

Content-Type

String

MIME类型, application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

path

String

文件系统内合法的目录全路径。单层目录长度不允许超过255,全路径长度不允许超过4096。

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

task_id

String

任务ID

状态码: 400

表5 响应Body参数

参数

参数类型

描述

errCode

String

错误码

errMsg

String

错误描述

状态码: 500

表6 响应Body参数

参数

参数类型

描述

errCode

String

错误码

errMsg

String

错误描述

请求示例

DU任务: |

创建一个查询目录资源使用情况的DU任务。path为文件系统内合法的目录全路径。单层目录长度不允许超过255,全路径长度不允许超过4096。

POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/{share_id}/fs/dir-usage/tasks

{
  "path" : "/path"
}

响应示例

状态码: 202

Accepted

{
  "task_id" : "d651ea2b-2b20-4c6d-8bbf-2adcec18dac9"
}

状态码: 400

错误响应

{
  "errCode" : "SFS.TURBO.0123",
  "errMsg" : "feature invalid"
}

状态码: 500

错误响应

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "internal server error"
}

状态码

状态码

描述

202

Accepted

400

错误响应

500

错误响应

错误码

请参见错误码

相关文档