华为云用户手册

请求示例 查询文件系统后端存储列表，文件系统ID为"630509b1-ded4-476e-8d06-dbbc3dc23900", 从target_id为"11abef677ac40f46644d1d5cfc2424a4"起，获取10个后端存储 GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/630509b1-ded4-476e-8d06-dbbc3dc23900/targets?marker=11abef677ac40f46644d1d5cfc2424a4&limit=10

响应参数 状态码：200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表5 响应Body参数 参数 参数类型 描述 count Integer 后端存储列表个数 targets Array of ShowBackendTargetInfoResponseBody objects 后端存储列表 表6 ShowBackendTargetInfoResponseBody 参数 参数类型 描述 target_id String 绑定关系ID creation_time String 绑定关系创建时间 file_system_path String 联动目录名称 failure_details FailureDetailsMessage object 绑定错误信息 lifecycle String 绑定状态 枚举值： CREATING AVAILABLE MISCONFIGURED DELETING FAILED obs ObsDataRepository object OBS类型后端存储 表7 FailureDetailsMessage 参数 参数类型 描述 message String 错误信息 表8 ObsDataRepository 参数 参数类型 描述 bucket String OBS桶名称 endpoint String OBS桶所在的区域 域名 policy ObsDataRepositoryPolicy object 后端存储自动同步策略 attributes ObsTargetAttributes object 后端存储属性。2024年6月30日及之前创建，且未升级的文件系统版本不支持该参数，请提工单处理。 表9 ObsDataRepositoryPolicy 参数 参数类型 描述 auto_export_policy AutoExportPolicy object 后端存储自动导出策略。当文件系统发生数据更新时，将自动导出到OBS桶。 表10 AutoExportPolicy 参数 参数类型 描述 events Array of strings 后端存储自动导出到OBS桶的数据更新类型。 NEW：表示新增数据，SFS Turbo联动目录下创建的文件，及之后对这些文件进行的元数据和数据修改，会被自动同步到OBS桶里。 CHANGED：表示修改数据，从OBS桶里导入到SFS Turbo联动目录下的文件，在SFS Turbo上对这些文件所进行的数据和元数据的修改，会被自动同步到OBS桶里。 DELETED：表示删除数据，在SFS Turbo联动目录下删除文件，OBS桶对应的对象也会被删除，只有被SFS Turbo写入的OBS对象才会被删除。 枚举值： NEW CHANGED DELETED prefix String 后端存储内对象匹配前缀 suffix String 后端存储内对象匹配后缀 表11 ObsTargetAttributes 参数 参数类型 描述 file_mode Integer 导入的文件权限。取值范围是0到777。 第一位表示文件所有者的权限，取值范围是0到7；第二位表示文件所属用户组的权限，取值范围是0到7；第三位表示其他用户的权限，取值范围是0到7。文件所有者由uid指定，文件所属用户组由gid指定，不是文件所有者且不在文件所属用户组的用户为其他用户。 数字4、2、1分别表示读、写、执行权限，这些数字相加，即可得到所需的权限组合。例如：750中第一位7代表该文件所有者对该文件具有读、写、执行权限；第二位5代表该文件所属用户组对该文件具有读、执行权限；第三位0代表其他用户对该文件无权限。 dir_mode Integer 导入的目录权限。取值范围是0到777。 第一位表示目录所有者的权限，取值范围是0到7；第二位表示目录所属用户组的权限，取值范围是0到7；第三位表示其他用户的权限，取值范围是0到7。目录所有者由uid指定，目录所属用户组由gid指定，不是目录所有者且不在目录所属用户组的用户为其他用户。 数字4、2、1分别表示读、写、执行权限，这些数字相加，即可得到所需的权限组合。例如：750中第一位7代表该目录所有者对该目录具有读、写、执行权限；第二位5代表该目录所属用户组对该目录具有读、执行权限；第三位0代表其他用户对该文件无权限。 uid Integer 导入对象所有者的用户id，默认值是0，取值范围是0到4,294,967,294（即2^32-2）。 gid Integer 导入对象所属用户组id，默认值是0，取值范围是0到4,294,967,294（即2^32-2）。 状态码：404 表12 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表13 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

请求示例 文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4ddw"，目录的全路径是“/data/test”，查询该目录的quota值 GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4ddw/fs/dir-quota?path=/data/test

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 path String 合法的已存在的目录的全路径 capacity Integer 目录的容量大小，单位：MB inode Integer 目录的inode数量限制 used_capacity Integer 目录已使用的容量大小，单位：MB。仅SFS Turbo 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB返回该字段。数据可能有延迟。 used_inode Integer 目录的已使用的inode数量。仅SFS Turbo 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB返回该字段。数据可能有延迟。 状态码：400 表5 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

响应示例 状态码：200 查询目录的配额信息成功 { "path" : "/data/test", "capacity" : 1024, "inode" : 100000 } 状态码：400 错误响应 { "errCode" : "SFS.TURBO.0102", "errMsg" : "Path is not directory" } 状态码：500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

响应参数 状态码：200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表4 响应Body参数 参数 参数类型 描述 task_id String 任务ID type String 任务类型 status String 任务状态 枚举值： SUC CES S DOING FAIL DELETING src_target String 联动目录名称 src_prefix String 导入导出任务的源端路径前缀 dest_target String 和src_target保持一致 dest_prefix String 和src_prefix保持一致 start_time String 任务开始时间 end_time String 任务结束时间 message String 任务执行结果信息 状态码：400 表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 错误描述

请求示例 文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4dde"， 任务ID为"11abef677ac40f46644d1d5cfc2424a4"，查询该任务的详情 "GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/77ba6f4b-6365-4895-8dda-bc7142af4dde/hpc-cache/task/11abef677ac40f46644d1d5cfc2424a4"

响应示例 状态码：200 成功 { "task_id" : "7bd2a9b6-xxxx-4605-xxxx-512d636001b0", "type" : "import_metadata", "status" : "DOING", "src_target" : "sfs-link-directory", "src_prefix" : "input/datasets/", "dest_target" : "sfs-link-directory", "dest_prefix" : "input/datasets/", "message" : "", "start_time" : "2023-09-02T15:04:05", "end_time" : "" } 状态码：400 错误响应 { "errCode" : "SFS.TURBO.0001", "errMsg" : "parameter error" } 状态码：500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

请求示例 批量添加共享标签，第一个标签的键为“key1”，值为“value1”；第二个标签的键为“key2”，值为“value1”。 { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ] }

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

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

请求示例 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

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

响应参数 状态码：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 错误描述

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

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

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

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

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

响应参数 状态码：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 错误描述

请求示例 文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4dde"，规则rule_id为"11abef677ac40f46644d1d5cfc2424a4", 删除该权限规则 DELETE HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/perm-rules/11abef677ac40f46644d1d5cfc2424a4

请求示例 文件系统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

接口约束 在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 成功 { "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 表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 错误描述

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 change_name 是 ShareName object 需要修改的SFS Turbo文件系统 表4 ShareName 参数 是否必选 参数类型 描述 name 是 String 需要修改的SFS Turbo文件系统的名字

接口约束 在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 个。查询超大目录耗时较久，请不要重复提交。