华为云用户手册

请求示例 文件系统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" : "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操作。该接口仅适用于20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型文件系统。后端有5min的缓存时间，查询的数据可能有延迟。标准型、标准型-增强版、性能型、性能型-增强版类型的SFS Turbo文件系统，请使用“查询目录资源使用情况”接口。

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 文件系统内合法的目录全路径 最小长度：0 最大长度：4096 used_capacity Long 占用容量，单位：byte 最小值：0 file_count FsFileCount object 该目录下所有文件数目 message String 错误信息 表5 FsFileCount 参数 参数类型 描述 dir Long 目录数目 最小值：0 regular Long 普通文件数目 最小值：0 pipe Long 管道文件数目 最小值：0 char Long 字符设备数目 最小值：0 block Long 块设备数目 最小值：0 socket Long 套接字数目 最小值：0 symlink Long 符号链接数目 最小值：0 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

请求示例 SFS Turbo上一代文件系统规格类型： | 创建一个名称为“sfs-turbo-test”的SFS Turbo标准型文件系统，共享协议为NFS，容量为500GB，文件系统所在的可用区编码是cn-north-4a。安全组ID为“8c4ebbd0-6edf-4aae-8353-xxx”，子网的网络ID为“b8884abe-f47b-4917-9f6c-xxx”，VPC ID为“d651ea2b-2b20-4c6d-8bbf-xxx”。 POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares { "share" : { "name" : "sfs-turbo-test", "availability_zone" : "cn-north-4a", "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx", "share_proto" : "NFS", "share_type" : "STANDARD", "size" : 500, "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx", "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx" } } SFS Turbo上一代文件系统规格类型+专属场景： | 创建一个名称为“sfs-turbo-dedicated-test”的SFS Turbo标准型文件系统，共享协议为NFS，容量为500GB，文件系统所在的可用区编码是cn-north-4a。指定专属的存储池id为“198f0704-xxx-4d85-xxx-c25caa4d3264”，专属的ecs规格为"c6.xlarge.2", 安全组ID为“8c4ebbd0-6edf-4aae-8353-xxx”，子网的网络ID为“b8884abe-f47b-4917-9f6c-xxx”，VPC ID为“d651ea2b-2b20-4c6d-8bbf-xxx”。 POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares { "share" : { "name" : "sfs-turbo-dedicated-test", "availability_zone" : "cn-north-4a", "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx", "share_proto" : "NFS", "share_type" : "STANDARD", "size" : 500, "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx", "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx", "metadata" : { "dedicated_flavor" : "c6.xlarge.2", "dedicated_storage_id" : "198f0704-xxx-4d85-xxx-c25caa4d3264" } } } 125MB/s/TiB： | 创建一个名称为“sfs-turbo-test”的SFS Turbo 125MB/s/TiB 文件系统，共享协议为NFS，容量为3686GB，规格类型为125MB/s/TiB, 文件系统所在的可用区编码是cn-north-4a。安全组ID为“8c4ebbd0-6edf-4aae-8353-xxx”，子网的网络ID为“b8884abe-f47b-4917-9f6c-xxx”，VPC ID为“d651ea2b-2b20-4c6d-8bbf-xxx”。 POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares { "share" : { "name" : "sfs-turbo-test", "availability_zone" : "cn-north-4a", "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx", "share_proto" : "NFS", "share_type" : "STANDARD", "size" : 3686, "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx", "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx", "metadata" : { "expand_type" : "hpc", "hpc_bw" : "125M" } } } HPC缓存型： | 创建一个名称为“sfs-turbo-hpccache-test”的SFS Turbo HPC缓存型文件系统，共享协议为NFS，容量为4096GB，hpc缓存型带宽为2GB/s， 文件系统所在的可用区编码是cn-north-4a。安全组ID为“8c4ebbd0-6edf-4aae-8353-xxx”，子网的网络ID为“b8884abe-f47b-4917-9f6c-xxx”，VPC ID为“d651ea2b-2b20-4c6d-8bbf-xxx”。 POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares { "share" : { "name" : "sfs-turbo-test", "availability_zone" : "cn-north-4a", "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx", "share_proto" : "NFS", "share_type" : "PERFORMANCE", "size" : 4096, "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx", "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx", "metadata" : { "expand_type" : "hpc_cache", "hpc_bw" : "2G" } } }

请求参数 表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文件系统的名字

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

接口约束 在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 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表5 响应Body参数 参数 参数类型 描述 dir_usage FsDirUasge object 消息描述 表6 FsDirUasge 参数 参数类型 描述 used_capacity Long 占用容量，单位：byte 最小值：0 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表8 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表9 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表10 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

URI DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/targets/{target_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id share_id 是 String 文件系统id target_id 是 String 绑定关系id 表2 Query参数 参数 是否必选 参数类型 描述 delete_data_in_file_system 否 Boolean 删除后端存储时是否同时删除文件系统内的联动目录及其数据文件，默认为 false。数据删除后无法恢复，请谨慎操作。

请求示例 文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4dde"，后端target_id为"11abef677ac40f46644d1d5cfc2424a4"，删除后端 DELETE HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/targets/11abef677ac40f46644d1d5cfc2424a4

响应参数 状态码： 202 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表5 响应Body参数 参数 参数类型 描述 target_id String 绑定关系id delete_data_in_file_system Boolean 删除后端存储时是否同时删除文件系统内的联动目录及其数据文件 lifecycle String 绑定状态。只支持DELETING和FAILED 枚举值： DELETING AVAILABLE MISCONFIGURED CREATING FAILED 状态码： 404 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 202 任务下发成功 { "target_id" : "00000334-xxxx-402d-a5d4-bxxxxx87b939", "delete_data_in_file_system" : false, "life_cycle" : "DELETING" } 状态码： 404 错误响应 { "errCode" : "SFS.TURBO.0126", "errMsg" : "target not found, not bound yet" } 状态码： 500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "internal server error" }

响应示例 状态码： 200 查询文件系统返回body { "id" : "8fba8253-c914-439d-ae8b-d5c89d0bf5e8", "name" : "sfs-turbo-8468", "status" : "200", "version" : "1.0.0", "region" : "cn-north-4", "availability_zone" : "cn-north-4a", "az_name" : "cn-north-4a", "created_at" : "2018-11-19T04:02:03", "export_location" : "192.168.0.90:/", "action_progress" : { }, "share_type" : "STANDARD", "sub_status" : "221", "vpc_id" : "b24e39e1-bc0c-475b-ae0c-aef9cf240af3", "subnet_id" : "86fc01ea-8ec8-409d-ba7a-e0ea16d4fd97", "security_group_id" : "50586458-aec9-442c-bb13-e08ddc6f1b7a", "size" : "600.00", "avail_capacity" : "600.00", "pay_model" : "0", "share_proto" : "NFS" }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 url 否 String ldap服务器的url，固定格式为 ldap://{ip_address}:{port_number} 或 ldaps://{ip_address}:{port_number}，例如ldap://192.168.1.1:60000 base_dn 否 String 数据库中的域 user_dn 否 String 用户区别名 password 否 String ldap认证密码 vpc_id 否 String vpc的id filter_condition 否 String 过滤条件。保留字段，暂不支持 backup_url 否 String ldap备节点的url，固定格式为 ldap://{ip_address}:{port_number} 或 ldaps://{ip_address}:{port_number}，例如ldap://192.168.1.2:60000 schema 否 String ldap的schema，不填写则默认为RFC2307 search_timeout 否 Integer ldap搜索的超时时间，单位为秒。不填写则默认为3秒 allow_local_user 否 String 访问ldap服务器失败后是否允许使用本地用户鉴权 枚举值： Yes No

请求示例 { "url" : "ldap://192.168.1.1:60000", "base_dn" : "dc=huawei,dc=com", "user_dn" : "cn=admin,dc=huawei,dc=com", "password" : "pwdxxxxxx", "vpc_id" : "26f6b565-xxxx-XXXX-xxxx-03f0bd975433", "backup_url" : "ldap://192.168.1.2:60000", "schema" : "RFC2307", "search_timeout" : 10, "allow_local_user" : "Yes" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 创建ldap异步任务的id 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 更新quota成功 { "path" : "/data/test", "capacity" : 1024, "inode" : 100000 } 状态码： 400 错误响应 { "errCode" : "SFS.TURBO.0102", "errMsg" : "Path is not directory" } 状态码： 403 错误响应 { "errCode" : "SFS.TURBO.0113", "errMsg" : "dir not create quota" } 状态码： 500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 path 是 String 合法的已存在的目录的全路径 capacity 否 Integer 目录的容量大小，单位：MB; 设置为0会导致数据无法写入目录; capacity和quota至少二选一 inode 否 Integer 目录的inode数量限制; 设置为0会导致数据无法写入目录; capacity和quota至少二选一

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 path String 合法的已存在的目录的全路径 capacity Integer 目录的容量大小，单位：MB inode Integer 目录的inode数量限制 used_capacity Integer 目录已使用的容量大小，单位：MB。仅SFSTurbo 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB返回该字段 used_inode Integer 目录的已使用的inode数量。仅SFSTurbo 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB返回该字段 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 任务下发成功 { "gc_time" : 10 } 状态码： 404 错误响应 { "errCode" : "SFS.TURBO.0002", "errMsg" : "share not exist" } 状态码： 500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表5 响应Body参数 参数 参数类型 描述 gc_time Integer 文件系统冷数据淘汰时间 状态码： 404 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的 token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 更新文件系统的操作类型。当前仅支持取值 config_gc_time gc_time 是 Integer 文件系统冷数据淘汰时间，单位为小时，取值范围 [1, 100000000]。系统默认为 60 小时

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 file_system_path 是 String 联动目录名称，SFS Turbo会在文件系统根目录下以该名称创建一个子目录，该目录用于绑定后端存储。必须是文件系统根目录下不存在的目录名，长度不能超过255个字符，子目录名称不能是“.”或“..”。不支持多层目录，不能包含字符'/'。 obs 是 ObsDataRepository object OBS类型后端存储 表4 ObsDataRepository 参数 是否必选 参数类型 描述 bucket 是 String OBS桶名称 endpoint 是 String OBS桶所在的区域域名

响应示例 状态码： 202 任务下发成功 { "target_id" : "00000334-xxxx-402d-a5d4-bxxxxx87b939", "creation_time" : "2023-11-19T04:02:03", "file_system_path" : "sfsturboDirName", "lifecycle" : "CREATING", "obs" : { "bucket" : "myBucket", "endpoint" : "obs.cn-north-7.ulanqab.huawei.com" } } 状态码： 400 错误响应 { "errCode" : "SFS.TURBO.0001", "errMsg" : "request path/body parameters invalid" } 状态码： 500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "internal server error" }

响应参数 状态码： 202 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表6 响应Body参数 参数 参数类型 描述 target_id String 绑定关系id creation_time String 绑定关系创建时间 failure_details FailureDetailsMessage object 绑定错误信息 file_system_path String 联动目录名称 lifecycle String 绑定状态。如果返回状态为CREATING，您需要通过获取后端存储详细信息接口去轮询绑定完成状态。 如果返回状态为AVAILABLE，代表绑定后端存储成功。如果返回状态MISCONFIGURED，代表绑定后端存储失败。DELETING 状态暂不支持。 枚举值： CREATING AVAILABLE MISCONFIGURED DELETING obs ObsDataRepository object OBS类型后端存储 表7 FailureDetailsMessage 参数 参数类型 描述 message String 错误信息 表8 ObsDataRepository 参数 参数类型 描述 bucket String OBS桶名称 endpoint String OBS桶所在的区域域名 状态码： 400 表9 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表10 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 创建ldap异步任务的id 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512