华为云用户手册

请求示例 文件系统ID为"630509b1-ded4-476e-8d06-dbbc3dc23900"，任务ID为"11abef677ac40f46644d1d5cfc2424a4"，获取DU任务详情 GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/630509b1-ded4-476e-8d06-dbbc3dc23900/fs/dir-usage/tasks/11abef677ac40f46644d1d5cfc2424a4

响应示例 状态码：200 成功 { "task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx", "status" : "SUC CES S", "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" }

URI GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID share_id 是 String 文件系统ID feature 是 String 任务类型。例，DU任务取值为dir-usage task_id 是 String 任务ID

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 task_id String 任务ID status String 任务状态, SUCCESS表示成功，DOING表示正在执行，FAIL表示失败 枚举值： 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' 表4 FsDuInfo 参数 参数类型 描述 path String 文件系统内合法的目录全路径 used_capacity Long 占用容量，单位：byte file_count FsFileCount object 该目录下所有文件数目 message String 错误信息 表5 FsFileCount 参数 参数类型 描述 dir Long 目录数目 regular Long 普通文件数目 pipe Long 管道文件数目 char Long 字符设备数目 block Long 块设备数目 socket Long 套接字数目 symlink Long 符号链接数目 状态码：400 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：404 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表9 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表10 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表11 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

接口约束 在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 HPC缓存型文件系统 标准型、标准型-增强版、性能型、性能型-增强版类型的SFS Turbo文件系统，请使用“查询目录资源使用情况”接口。

响应示例 状态码：200 目录资源使用情况 { "dir_usage" : { "used_capacity" : 1024000 } } 状态码：400 错误响应 { "errCode" : "SFS.TURBO.0102", "errMsg" : "Path is not directory" } 状态码：500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

响应参数 状态码：200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表5 响应Body参数 参数 参数类型 描述 dir_usage FsDirUasge object 消息描述 表6 FsDirUasge 参数 参数类型 描述 used_capacity Long 占用容量，单位：byte 状态码：400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表8 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表9 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表10 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

接口约束 在2023年8月1号之后创建的文件系统支持该API操作。该接口仅适用于SFS Turbo上一代文件系统规格类型（标准型、标准型-增强版、性能型、性能型-增强版）。20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型的SFS Turbo文件系统，请使用“创建文件系统异步任务”接口。该接口并发请求数过大可能会影响文件系统性能，建议同时提交的查询请求不要超过 4 个。查询超大目录耗时较久，请不要重复提交。

响应示例 状态码：200 查询目录结果 { "path" : "/date/test" } 状态码：400 错误响应 { "errCode" : "SFS.TURBO.0100", "errMsg" : "invalid path" } 状态码：404 错误响应，目录不存在 { "errCode" : "SFS.TURBO.0101", "errMsg" : "path not exist" } 状态码：500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 path String 目录全路径 mode Long 目录权限，仅20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型文件系统返回该字段。第三位表示目录所有者的权限，第四位表示目录所属用户组的权限，第五位表示其他用户的权限。目录所有者由uid指定，目录所属用户组由gid指定，不是目录所有者且不在目录所属用户组的用户为其他用户。例如：40755中第三位7代表目录所有者对该目录具有读、写、执行权限；第四位5代表目录所属用户组对该目录具有读、执行权限；第五位5代表其他用户对该目录具有读、执行权限。 uid Long 目录所有者的用户id，仅20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型文件系统返回该字段。 gid Long 目录所属用户组id，仅20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型文件系统返回该字段。 状态码：400 表5 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：404 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

响应参数 状态码：200 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 状态码：400 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表9 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表10 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表11 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 update_hpc_cache 是 ReqUpdateHpcCacheInfo object 后端挂载信息 表4 ReqUpdateHpcCacheInfo 参数 是否必选 参数类型 描述 action 是 String 配置hpc缓存型的动作，如initialize_overlay data 是 ReqUpdateHpcCacheData object hpc 缓存型后端配置信息 表5 ReqUpdateHpcCacheData 参数 是否必选 参数类型 描述 gc_time 是 Long 冷数据淘汰时间。单位：小时。指定时间内线上缓存的数据如果没有被访问则会自动从缓存中删除。0表示数据不会因为时间原因自动从缓存中删除。 ck_time 是 Long 后端校验时间。单位：秒。指定时间间隔进行线上缓存文件与后端存储文件比较，存在变化则自动更新。0表示文件进行实时校验。 nas 否 Array of ConfigNasTarget objects 配置 nas 后端的信息 表6 ConfigNasTarget 参数 是否必选 参数类型 描述 name 是 String nas 配置名 type 是 String nas 配置协议类型 url 是 String nas 配置 ip

请求示例 配置hpc缓存型后端信息，冷数据淘汰时间是100小时，后端校验时间是60秒。配置Nas后端信息，nas 配置 ip是“192.168.xx.xx:/”，nas 配置协议类型是“NFS”。 { "update_hpc_cache" : { "action" : "initialize_overlay", "data" : { "gc_time" : 100, "ck_time" : 60, "nas" : [ { "name" : "abc", "type" : "NFS", "url" : "192.168.xx.xx:/" } ] } } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 tags Array of Tag objects tag标签的列表 表5 Tag 参数 参数类型 描述 key String 标签的键。 最大长度128个字符。 key不能为空。 values Array of strings 值列表。每个值最大长度255个字符，如果values为空列表，则表示匹配任意值value。value之间为或的关系。

请求示例 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 表4 响应Body参数 参数 参数类型 描述 tasks Array of OneFsTaskResp objects 任务列表 表5 OneFsTaskResp 参数 参数类型 描述 task_id String 任务ID status String 任务状态, SUCCESS表示成功，DOING表示正在执行，FAIL表示失败 枚举值： 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' 表6 FsDuInfo 参数 参数类型 描述 path String 文件系统内合法的目录全路径 used_capacity Long 占用容量，单位：byte file_count FsFileCount object 该目录下所有文件数目 message String 错误信息 表7 FsFileCount 参数 参数类型 描述 dir Long 目录数目 regular Long 普通文件数目 pipe Long 管道文件数目 char Long 字符设备数目 block Long 块设备数目 socket Long 套接字数目 symlink Long 符号链接数目 状态码：400 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表9 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：404 表10 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表11 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表12 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表13 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

响应示例 状态码：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" }

URI GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID share_id 是 String 文件系统ID feature 是 String 任务类型。例，DU任务取值为dir-usage 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String marker，取值为task_id limit 否 Integer limit, 取值为正整数. 默认为20，最大值为100

接口约束 在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 HPC缓存型文件系统 标准型、标准型-增强版、性能型、性能型-增强版类型的SFS Turbo文件系统，请使用“查询目录资源使用情况”接口。

SFS Turbo错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400/404 SFS.TURBO.0001 Parameter error 参数错误 请使用合法的参数重试。 400/404 SFS.TURBO.0002 Cluster not found 对象不存在或没有权限 请使用合法的参数重试。 400 SFS.TURBO.0003 Invalid name 名称不符合规则 请使用合法的参数重试。 400 SFS.TURBO.0004 Invalid vpc 指定的vpc无效 请使用合法的参数重试。 400/500 SFS.TURBO.0005 Internal server error 内部错误 请联系技术支持。 400 SFS.TURBO.0006 Invalid subnet 指定的subnet无效 请使用合法的参数重试。 400 SFS.TURBO.0007 Invalid share type 文件系统类型不合法 请使用合法的参数重试。 400 SFS.TURBO.0008 Invalid size 文件系统大小不在支持的范围内 请使用合法的参数重试。 409 SFS.TURBO.0009 Name has existed 文件系统名称已经存在 请使用合法的参数重试。 400 SFS.TURBO.0010 Quota exceeds 配额不足 请提工单扩大配额。 400/403 SFS.TURBO.0011 Cluster is doing something 该文件正在进行其它操作，无法执行该操作，请稍后重试 等待其他操作完成，然后进行重试 400 SFS.TURBO.0012 Operation is not allowed 包周期文件系统不支持通过API进行扩容、删除操作。 请在控制台进行包周期文件系统的管理。 400 SFS.TURBO.0015 do not have the operation permission 没有操作权限 请申请相关权限 400 SFS.TURBO.0016 Res tag count already reach max value 资源标签达到上限 删除无用标签 400 SFS.TURBO.0017 Invalid tag key param 资源标签key长度非法 请使用合法的参数重试。 400 SFS.TURBO.0018 Invalid tag value param 资源标签value长度非法 请使用合法的参数重试。 404 SFS.TURBO.0019 Invalid Job Id 指定的job id不存在 请使用合法的job id 400 SFS.TURBO.0020 Invalid flavor 指定的flavor不存在 请使用合法的flavor 400 SFS.TURBO.0021 file system not match 类型不匹配，同一实例类型不满足磁盘一致性 请确保同一实例类型满足磁盘一致性 400 SFS.TURBO.0022 backup name already exists 备份名称已经存在 请更换备份名称 400 SFS.TURBO.0023 Invalid flavor ref 规格码非法 请使用合法的规格码 400 SFS.TURBO.0024 Operation is not allowed 该文件系统不支持该操作，请联系技术支持 请联系技术支持。 400 SFS.TURBO.0025 Invalid tag key param 资源标签key含有非法字符 请使用合法的参数重试。 400 SFS.TURBO.0026 Invalid tag value param 资源标签value含有非法字符 请使用合法的参数重试。 400 SFS.TURBO.0027 Invalid security group 指定的安全组无效 请使用合法的参数重试。 400 SFS.TURBO.0028 Invalid crypt key 指定的密钥无效 请使用合法的参数重试。 400 SFS.TURBO.0029 Subnet has not enough ips 子网可用IP不足 请使用合法的参数重试。 400 SFS.TURBO.0030 Ecs resource not enough E CS 资源不足，该规格在选择的AZ售罄 请更换可用区重试。 400 SFS.TURBO.0031 cache type not exist cache_type不存在 请使用合法的cache_type 400 SFS.TURBO.0032 EVS Resource Not Enough 云盘资源不足 请扩充云盘资源 500 SFS.TURBO.0033 Get Client Ips Error 获取客户端IP失败 请重新获取客户端IP，如果问题无法解决，请及时联系技术支持 400 SFS.TURBO.0034 dedicated storage resource not enough 专属存储池资源不足 请扩充专属存储池资源 400 SFS.TURBO.0035 The current type does not support backup. 当前类型不支持备份 当前类型不支持备份 500 SFS.TURBO.0036 Failed to obtain the used capacity of the directory 获取目录使用容量失败 请重新获取目录使用容量，如果问题无法解决请及时联系技术支持 400 SFS.TURBO.0037 Operation conflict, client retry 操作冲突，客户端重试 请使用合法的操作 400 SFS.TURBO.0038 unknown error 未知错误 请联系技术支持 400 SFS.TURBO.0039 The VIP quota is insufficient vip配额不足 请申请更多的VIP配额 400 SFS.TURBO.0040 Insufficient Security Group Quota 安全组配额不足 请增加安全组配额 400 SFS.TURBO.0041 Operation is not allowed 文件系统版本较低，不支持该操作 请联系技术支持 404 SFS.TURBO.0042 Invalid NIC ID 指定的NIC ID不存在或为空 请使用合法的参数重试 400 SFS.TURBO.0100 Invalid file system path 文件系统路径非法 请使用合法的文件系统路径 404 SFS.TURBO.0101 The file system path does not exist 文件系统路径不存在 请选择合法的文件系统路径 400 SFS.TURBO.0102 The file system path is not a directory 文件系统路径非目录 请选择合法的文件系统路径 400 SFS.TURBO.0103 The file system is being processed 文件系统正在处理中 请等待文件系统处理完成 500 SFS.TURBO.0104 Failed to import or export OBS data obs导入导出操作失败 请重新导入导出obs，若问题未解决，请联系技术支持 500 SFS.TURBO.0105 Failed to obtain OBS import and export task data 获取obs导入导出任务数据失败 请重新获取obs导入导出的数据，如果问题未得到解决，请联系技术支持 400 SFS.TURBO.0106 The OBS task does not exist obs 任务不存在 请选择存在的obs任务或者创建相应的obs任务 400 SFS.TURBO.0107 OBS protocol error 配置后端type参数错误 请联系技术支持 400 SFS.TURBO.0108 The OBS endpoint name is incorrect obs 域名 错误 请联系技术支持 400 SFS.TURBO.0109 The OBS bucket name is incorrect obs 桶名错误 请使用合法的obs桶名 400 SFS.TURBO.0110 OBS agent error 导入导出任务失败 请联系技术支持 400 SFS.TURBO.0111 The OBS configuration list is empty obs 配置列表为空 请使用合法的obs配置信息 父主题： 附录

响应示例 状态码：200 删除中 { "job_Id" : "72362dxxxxa04d419dbd5e6d9fe5xxxx" } 状态码：400 错误响应 { "errCode" : "SFS.TURBO.0001", "errMsg" : "Invalid rule id" } 状态码：500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

请求示例 ID为"77ba6f4b-6365-4895-8dda-bc7142af4dde"的文件系统，删除任务ID为"11abef677ac40f46644d1d5cfc2424a4"的DU任务 DELETE HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/dir-usage/tasks/11abef677ac40f46644d1d5cfc2424a4

接口约束 在2023年8月1号之后创建的文件系统支持该API操作。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文件系统，请使用“查询目录资源使用情况”接口。

响应参数 状态码：202 Accepted 状态码：400 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表4 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：404 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表8 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

响应示例 状态码：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" }

URI DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID share_id 是 String 文件系统ID feature 是 String 任务类型。例，DU任务取值为dir-usage task_id 是 String 任务ID

响应示例 状态码：200 请求已被接受 { "jobId" : "72362dxxxxa04d419dbd5e6d9fe5xxxx" } 状态码：400 客户端错误 { "errCode" : "SFS.TURBO.0001", "errMsg" : "Invalid rule id" } 状态码：500 内部错误 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

响应示例 状态码：202 Accepted { "task_id" : "7bd2a9b6-xxxx-4605-xxxx-512d636001b0" } 状态码：400 客户端错误 { "errCode" : "SFS.TURBO.0001", "errMsg" : "parameter error" } 状态码：500 内部错误 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

接口约束 在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文件系统，请使用“查询目录资源使用情况”接口。

响应示例 状态码：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" }