华为云用户手册

响应参数 状态码： 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 绑定状态 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对象才会被删除。 表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 错误描述

URI GET /v1/{project_id}/sfs-turbo/shares/{share_id}/targets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id share_id 是 String 文件系统id 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询列表返回元素个数 marker 否 String 查询列表偏移量

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 ip_cidr 否 String 授权对象的IP地址或网段，设置后不支持修改 rw_type 否 String 授权对象的读写权限 rw：默认选项，以读写的方式共享 ro：以只读的方式共享 none: 没有权限 user_type 否 String 授权对象的系统用户对文件系统的访问权限。取值如下： no_root_squash：默认选项。客户端使用包括root用户在内的任何用户，NFS服务器都保持客户端使用的用户，不做映射。 root_squash：客户端使用的是root用户时，映射到NFS服务器的用户为NFS的匿名用户（nfsnobody）。客户端使用非root用户时，NFS服务器保持客户端使用的用户，不做映射。 all_squash：所有访问NFS服务器的客户端的用户都映射为匿名用户。

响应示例 状态码： 200 创建成功 { "id" : "1131ed520xxxxxxebedb6e57xxxxxxxx", "ip_cidr" : "192.32.0.0/16", "rw_type" : "rw", "user_type" : "no_root_squash" } 状态码： 400 错误响应 { "errCode" : "SFS.TURBO.0001", "errMsg" : "Invalid rule id" } 状态码： 500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 权限规格的id ip_cidr String 授权对象的IP地址或网段 rw_type String 授权对象的读写权限 rw：默认选项，以读写的方式共享 ro：以只读的方式共享 none: 没有权限 user_type String 授权对象的系统用户对文件系统的访问权限。取值如下： no_root_squash：客户端使用的是root用户时，映射到NFS服务器的用户依然为root用户。 root_squash：客户端使用的是root用户时，映射到NFS服务器的用户为NFS的匿名用户（nfsnobody）。 all_squash：默认选项。所有访问NFS服务器的客户端的用户都映射为匿名用户。' 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码： 500 表6 响应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 查询目录的配额信息成功 { "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 表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 错误码 errMsg String 错误描述 状态码： 500 表6 响应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" }

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表4 响应Body参数 参数 参数类型 描述 task_id String 任务ID type String 任务类型 status String 任务状态 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 错误描述

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 change_security_group 是 ChangeSecurityGroup object change_security_group对象 表4 ChangeSecurityGroup 参数 是否必选 参数类型 描述 security_group_id 是 String 需要修改的目标安全组ID。

请求示例 { "rules" : [ { "ip_cidr" : "192.168.xx.xx/16", "rw_type" : "rw", "user_type" : "no_root_squash" }, { "ip_cidr" : "192.32.xx.xx/16", "rw_type" : "rw", "user_type" : "no_root_squash" } ] }

响应示例 状态码： 200 创建成功 { "rules" : [ { "id" : "1131ed520xxxxxxebedb6e57xxxxxxxx", "ip_cidr" : "192.32.0.0/16", "rw_type" : "rw", "user_type" : "no_root_squash" }, { "id" : "1131ed520xxxxxxebedb6e57xxxxxxxx", "ip_cidr" : "192.32.0.1", "rw_type" : "rw", "user_type" : "no_root_squash" } ] } 状态码： 400 错误响应 { "errCode" : "SFS.TURBO.0001", "errMsg" : "Rules not allowed empty" } 状态码： 500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 rules 是 Array of OnePermRuleRequestInfo objects 权限信息，一次最多允许添加5条规则 表4 OnePermRuleRequestInfo 参数 是否必选 参数类型 描述 ip_cidr 否 String 授权对象的IP地址或网段，设置后不支持修改 rw_type 否 String 授权对象的读写权限 rw：默认选项，以读写的方式共享 ro：以只读的方式共享 none: 没有权限 user_type 否 String 授权对象的系统用户对文件系统的访问权限。取值如下： no_root_squash：默认选项。客户端使用包括root用户在内的任何用户，NFS服务器都保持客户端使用的用户，不做映射。 root_squash：客户端使用的是root用户时，映射到NFS服务器的用户为NFS的匿名用户（nfsnobody）。客户端使用非root用户时，NFS服务器保持客户端使用的用户，不做映射。 all_squash：所有访问NFS服务器的客户端的用户都映射为匿名用户。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 rules Array of OnePermRuleResponseInfo objects 权限规格信息 表6 OnePermRuleResponseInfo 参数 参数类型 描述 id String 权限规格的id ip_cidr String 授权对象的IP地址或网段 rw_type String 授权对象的读写权限 rw：默认选项，以读写的方式共享 ro：以只读的方式共享 none: 没有权限 user_type String 授权对象的系统用户对文件系统的访问权限。取值如下： no_root_squash：客户端使用的是root用户时，映射到NFS服务器的用户依然为root用户。 root_squash：客户端使用的是root用户时，映射到NFS服务器的用户为NFS的匿名用户（nfsnobody）。 all_squash：默认选项。所有访问NFS服务器的客户端的用户都映射为匿名用户。' 状态码： 400 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码： 500 表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

请求示例 SFS Turbo上一代文件系统规格类型： 创建一个名称为“sfs-turbo-test”的SFS Turbo标准型文件系统，共享协议为NFS，容量为500GB，文件系统所在的可用区编码是example。安全组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" : "example", "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，文件系统所在的可用区编码是example。指定专属的存储池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" : "example", "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, 文件系统所在的可用区编码是example。安全组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" : "example", "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" } } }

请求参数 表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 状态码： 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 错误描述

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

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。数据删除后无法恢复，请谨慎操作。

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

响应示例 状态码： 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 更新中 { "jobId" : "72362dxxxxa04d419dbd5e6d9fe5xxxx" } 状态码： 400 错误响应 { "errCode" : "SFS.TURBO.0001", "errMsg" : "Invalid rule id" } 状态码： 500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

功能介绍 修改ldap配置。LDAP（Lightweight Directory Access Protocol），中文名称轻量级目录访问协议，是对目录服务器（Directory Server）进行访问、控制的一种标准协议。LDAP服务器可以集中式地管理用户和群组的归属关系，通过绑定LDAP服务器，当一个用户访问您的文件系统的文件时，SFS Turbo将会访问您的LDAP服务器以进行用户身份验证，并且获取用户和群组的归属关系，从而进行Linux标准的文件UGO权限的检查。要使用此功能，首先您需要搭建好LDAP服务器（当前SFS Turbo仅支持LDAP v3协议），常见提供LDAP协议访问的目录服务器实现有OpenLdap(Linux)，Active Directory(Windows)等，不同目录服务器的实现细节有所差别，绑定时需要指定对应的Schema（Schema配置错误将会导致SFS Turbo无法正确获取用户以及群组信息，可能导致无权限访问文件系统内文件），当前SFS Turbo支持的Schema有： RFC2307（Openldap通常选择此Schema） MS-AD-BIS（Active Directory通常选择此Schema，支持RFC2307bis，支持嵌套的群组） SFS Turbo还支持配置主备LDAP服务器，当您的一台LDAP服务器故障无法访问后，SFS Turbo将会自动切换到备LDAP服务器访问，以免影响您的业务。同时，若您还选择将allow_local_user配置为Yes（默认为No），那么当您的LDAP服务器全部故障无法访问时，SFS Turbo将会使用您的本地用户以及群组信息，而非LDAP服务器中配置的信息进行身份验证和UGO权限检查，以最大程度减少故障影响面。

请求参数 表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.xx.xx: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.xx.xx:60000 schema 否 String ldap的schema，不填写则默认为RFC2307 search_timeout 否 Integer ldap搜索的超时时间，单位为秒。不填写则默认为3秒 allow_local_user 否 String 访问ldap服务器失败后是否允许使用本地用户鉴权