华为云用户手册

请求消息 参数说明 参数 是否必选 参数类型 描述 os-shrink 是 Object os-shrink对象。 os-shrink字段说明： 参数 是否必选 参数类型 描述 new_size 是 Integer 缩容后share的新容量，以GB为单位。 请求样例 缩容共享，缩容后共享的新容量为1GB。 { "os-shrink": { "new_size": 1 } }

请求消息 参数说明 参数 是否必选 参数类型 描述 offset 否 String 索引位置。整型数字字符串，默认为0，必须为数字，不能为负数。返回的结果中第一条记录为符合查询条件的第offset+1条记录。 limit 否 String 查询记录数。整型数字字符串，默认为1000。最小值为1，最大值为1000。 返回的结果中记录数不超过limit。 action 是 String 操作标识。取值范围为：“filter”和“count”。 根据标签查询共享详情时使用“filter”。 matches 否 Array of matchs 共享资源搜索字段。当该字段不设置时，默认为搜索租户的所有共享。 tags 否 Array of tags 标签搜索字段。包含标签，结果返回满足tags搜索条件的共享资源列表。搜索条件中所有tag之间是“与”的关系，即只有当所有tag搜索条件都满足时，共享资源才可以被搜索。每个tag搜索条件的key-values结构中values数组的值之间是“或”的关系。无tags过滤条件时，默认认为这个标签搜索字段满足要求。最多包含10个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key-values结构中values的值之间不能重复。 tags_any 否 Array of tags 标签搜索字段。包含任意标签，结果返回满足tags_any搜索条件的共享资源列表。搜索条件中所有tag之间是“或”的关系，即只要有其中一个tag搜索条件满足要求时，共享资源便可以被搜索。每个tag搜索条件的key-values结构中values数组之间是“或”的关系。无tags_any过滤条件时，默认认为这个标签搜索字段满足要求。查询条件最多包含10个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key-values结构中values的值之间不能重复。 not_tags 否 Array of tags 标签搜索字段。不包含标签，结果返回满足not_tags搜索条件的共享资源列表，搜索条件中所有tag之间是“或非”的关系，即只有当所有tag搜索条件都不满足要求时，共享资源才可以被搜索。每个tag搜索条件的key-values结构中values数组的值之间是“或”的关系。无not_tags过滤条件时，默认认为这个标签搜索字段满足要求。最多包含10个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key-values结构中values的值之间不能重复。 not_tags_any 否 Array of tags 标签搜索字段。不包含任意标签，结果返回满足not_tags_any搜索条件的共享资源列表，查询条件中所有tag之间是“与非”的关系，即只要有一个tag搜索条件不满足要求时，共享资源便可以被搜索。每个tag搜索条件的key-values结构中values数组之间是“或”的关系。无not_tags_any过滤条件时，默认认为这个标签搜索字段满足要求。查询条件最多包含10个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key-values结构中values的值之间不能重复。 sys_tags 否 Array of tags 仅op_service权限可以使用此字段做资源实例过滤条件： 目前TMS调用时只包含一个tag结构体 key：_sys_enterprise_project_id。 目前TMS调用时key下面只包含一个value，0表示默认企业项目。 sys_tags和租户标签过滤条件（tags、tags_any、not_tags、not_tags_any）不能同时使用。 请求参数中，标签搜索字段tags/not_tags/tags_any/not_tags_any为非必选且可以任意自由组合，标签搜索字段tags/not_tags/tags_any/not_tags_any之间为“与”的关系。 match字段说明： 参数 是否必选 参数类型 描述 key 是 String 键。固定值为"resource_name"。 value 是 String 值。需要查询的共享的名称。value为空字符串时，精确匹配名称为空的共享，为非空字符串时模糊匹配（不区分大小写）。每个值最大长度为255个字符 。 tag字段说明： 参数 是否必选 参数类型 描述 key 是 String 标签的键。最大长度127个字符。 key不能为空。 values 是 Array of strings 值列表。每个值最大长度255个字符，如果values为空列表，则表示匹配任意值value。value之间为或的关系。 请求样例 根据标签查询共享详情，要查询的共享的标签的键是“key1”，值为“value2”。 { "offset": "0", "limit": "100", "action": "filter", "matches": [{ "key": "resource_name", "value": "share_name" }], "tags": [{ "key": "key1", "values": ["value2"] }, { "key": "key2", "values": [] }], "tags_any": [{ "key": "key3", "values": ["value3"] }, { "key": "key4", "values": [] }], "not_tags": [{ "key": "key5", "values": ["value5"] }, { "key": "key6", "values": [] }], "not_tags_any": [{ "key": "key7", "values": ["value7", "value8"] }, { "key": "key9", "values": [] }] }

状态码 正常 200 异常 状态码 说明 400 Bad Request 服务器未能处理请求。 400 Bad Request 无效输入：缩容后的大小必须大于0并小于当前大小（当前：XX，新大小：XX） 400 Bad Request 无效输入：扩容后的大小必须大于当前大小（当前：XX，新大小：XX） 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

响应消息 参数说明 参数 参数类型 描述 versions Object 所有可用的API版本列表对象。 version字段说明： 参数 参数类型 描述 id String 所使用版本的公用名称。 updated String 接口最后修改的UTC时间，格式为YYYY-MM-DDTHH:MM:SSZ status String API 版本的状态。其值为： CURRENT：当前API使用的首选版本。 SUPPORTED：表示该版本为老版本，但当前还在继续支持。 DEPRECATED：表示该版本为废弃版本，存在后续删除的可能。 links Array of objects 共享链接。参见links字段说明。 media-types Array of objects API支持的媒介类型，参见media-types字段说明。 version String 如果当前版本的API支持microversions，此处为支持的microversion的最大版本。如果不支持microversions，这将会是空字符串。 min_version String 如果当前版本的API支持microversions, 此处为支持的microversion的最小版本。如果不支持microversions, 这将会是空字符串。 links字段说明： 参数 参数类型 描述 href String API接口访问路径，作为参考。 type String 参考接口返回的信息文本类型。 rel String 链接附加描述。 media-types字段说明： 参数 参数类型 描述 base String 文本基础类型。 type String 文本类型。 响应样例 { "versions": [ { "status": "CURRENT", "updated": "2015-08-27T11:33:21Z", "links": [ { "href": "http://docs.openstack.org/", "type": "text/html", "rel": "describedby" }, { "href": "https://sfs.region.www.t-systems.com/v2/", "rel": "self" } ], "min_version": "2.0", "version": "2.28", "media-types": [ { "base": "application/json", "type": "application/vnd.openstack.share+json;version=1" } ], "id": "v2.0" } ] }

请求示例 DELETE / HTTP/1.1 User-Agent: curl/7.29.0 Host: examplefilesystem.sfs3.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 02:31:25 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:jZiAT8Vx4azWEvPRMWi0X5BpJMA=

响应示例 HTTP/1.1 204 No Content Server: OBS X-Obs-Request-Id: 0000018893B8081DC047305E783867DD X-Obs-Id-2: 32AAAQAAEAABSkAgAAEAABAAAQAAEAABCT5UWgsaro3EEnOsNEzf8w8dnydR+Eak Date: WED, 01 Jul 2015 02:31:25 GMT

状态码 正常 200 异常 状态码 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 413 Request Entity Too Large 用户配额不足。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

请求消息 参数说明 参数 是否必选 参数类型 描述 share 是 Object 详见share字段说明 share字段说明： 参数 是否必选 参数类型 描述 share_proto 是 String 文件系统共享协议，有效值为NFS（适用于linux系统）。 size 是 Integer 共享容量，单位GB。申请的共享容量不能大于配额值，需要查看配额，请参考配额查询接口。 name 否 String 共享名称，长度为0~255，只支持英文字母、数字、中划线、下划线。 description 否 String 共享描述信息，长度为0~255，只支持英文字母、数字、中划线、下划线。 is_public 否 Boolean （API 微版本2.8到2.42支持）共享的可见程度。设置为true时公共可见，设置为false时私有个人可见，默认值为false。 availability_zone 否 String AZ( availability zone)的名称，如果不输入AZ信息，后台会当成默认AZ处理，默认AZ中如果无存储资源，共享创建会失败。长度为0~255。 metadata 否 Object 创建共享的metadata信息，一到多个字典形式组织的键值对组成，见metadata字段说明。 注意： 出于系统安全考虑，现未开放修改metadata字段的API接口，因此，通过metadata字段创建包含 数据加密 功能的共享时，请确保相应参数和值正确。 metadata字段中以下规则的键，除非已经明确可以被设置的（例如“#sfs_crypt_key_id”等），其他的为系统内部使用，请勿自定义设置，避免因与系统预定义键冲突导致的系统内部错误： 字符串“share_used”。 以字符串“#sfs”开头。 metadata字段说明（创建共享，同时共享具有数据加密功能） 创建具有数据加密功能的共享时，请首先参考《数据加密服务API参考》中的“查询密钥列表”章节通过HTTPS请求获取加密密钥的密钥ID、DomainID和密钥别名，然后在metadata字段中设置如下字典形式组织的键值对，请务必确保metadata字段中的键值对正确。 当需要创建具有数据加密功能的共享时，以下参数均为必选。如仅需要创建普通共享时，以下参数均为可选。 键 值类型 是否必选 说明 #sfs_crypt_key_id String 是 加密密钥ID。 该字段与“#sfs_crypt_domain_id”和“#sfs_crypt_alias”字段同时存在时表示启动数据加密功能。 #sfs_crypt_domain_id String 是 租户的Domain id。 该字段与“#sfs_crypt_key_id”和“#sfs_crypt_alias”字段同时存在时表示启动数据加密功能。 #sfs_crypt_alias String 是 加密密钥别名。 该字段与“#sfs_crypt_key_id”和“#sfs_crypt_domain_id”字段同时存在时表示启动数据加密功能。 建议使用弹性文件服务的默认密钥“sfs/default”的来创建加密共享请参考《弹性文件服务用户指南》中的“文件系统加密”章节和“加密”章节获取详细信息和注意事项)。 创建带企业项目ID的共享时，metadata中的键如下： 键 值类型 是否必选 说明 enterprise_project_id String 是 企业项目ID。 在租户开启企业项目功能的情况下，enterprise_project_id作为key，value为企业项目ID，给共享绑定企业项目ID。 请求样例 ：POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares 创建共享，共享协议类型为NFS，共享容量为1GB，共享的可见程度为私有个人可见。 { "share": { "name": "test", "description": "test description", "share_proto": "NFS", "share_network_id": null, "size": 1, "is_public": false } }

响应消息 参数说明 参数 参数类型 描述 share Object 详细参数说明请参见share字段说明 share字段说明： 参数 参数类型 描述 links Array 共享链接。 availability_zone String 可用区AZ(availability zone)。 share_server_id String 共享服务管理的ID id String 共享的ID。 size Integer 共享容量，单位GB。 project_id String 创建共享的项目的ID。 metadata Object 一到多个字典形式组织的键值对。其中share_used作为key，对应的value表示共享已经使用的容量，单位是Bytes；enterprise_project_id作为key，对应的value是共享所属的企业项目ID。 status String 共享的状态。 description String 共享描述。 host String 共享主机名。 name String 共享名称。 created_at String 共享创建的时间标签。 share_proto String 文件系统的共享协议。 share_type_name String 共享类型的名称,共享类型用于指定分配哪些类型的存储服务，例如高性能类型（由SSD磁盘组成）、大容量类型（由SATA盘组成）。（API 微版本2.6以后支持）。 share_type String 共享类型的ID。 volume_type String 卷类型,，与share_type含义相同。 export_locations Array 共享挂载路径信息列表，当前只支持有一个共享。当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.9，该字段存在，若为2.9到2.42之间，该消息不存在。 export_location String 共享挂载路径，当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.9，该字段存在，若为2.9到2.42之间，该消息不存在。 is_public Boolean 共享的可见程度。设置为true时公共可见，设置为false时私有个人可见，默认值为false。 响应样例 { "share": { "status": "creating", "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", "name": "share_London", "share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7", "availability_zone": "az1.dc1", "created_at": "2015-09-18T10:25:24.533287", "export_location": null, "links": [ { "href": "http://192.168.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", "rel": "self" }, { "href": "http://192.168.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", "rel": "bookmark" } ], "share_network_id": null, "export_locations": [], "share_proto": "NFS", "host": null, "volume_type": "default", "snapshot_id": null, "is_public": true, "metadata": { "project": "my_app", "aim": "doc" }, "id": "011d21e2-fbc3-4e4a-9993-9ea223f73264", "size": 1, "description": "My custom share London" } } 客户端收到系统响应时，共享创建任务还未结束，因此，共享路径不能马上查询到，当创建任务完成后，用户可以通过共享路径信息查询接口查询出来。

功能介绍 创建文件共享。创建文件系统成功后，您还需前往弹性云服务器执行挂载操作，才能实现多个云服务器共享文件存储。挂载相关操作请参考弹性文件服务快速入门。 该接口为异步接口，返回为200只是表示接口下发接收成功，后续可以通过查询共享详细信息查询共享的共享状态和共享路径，判断创建共享是否完成以及是否成功，如果共享状态变为available，或者共享路径已经生成，说明创建已经成功。 通过该接口创建共享成功后，用户还需要参考添加共享访问规则添加共享访问规则，之后才可正常使用创建的共享。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 path 是 String 合法的已存在的目录的全路径 capacity 否 Integer 目录的容量大小，单位：MB inode 否 Integer 目录的inode数量限制

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

状态码 正常 202 异常 状态码 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

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

请求参数 表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" }

响应参数 状态码： 200 表3 响应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 表4 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

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

响应示例 状态码： 200 查询成功 { "id" : "1131ed520xxxxxxebedb6e57xxxxxxxx", "ip_cidr" : "192.168.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" }

请求消息 参数说明 参数 是否必选 参数类型 描述 action 是 String 操作标识。取值范围为：“filter”和“count”。 根据标签查询共享实例个数时使用“count”。 matches 否 Array of matches 共享资源搜索字段。当该字段不设置时，默认为搜索租户的所有共享。 tags 否 Array of tags 标签搜索字段。包含标签，结果返回满足tags搜索条件的共享资源列表。搜索条件中所有tag之间是“与”的关系，即只有当所有tag搜索条件都满足时，共享资源才可以被搜索。每个tag搜索条件的key-values结构中values数组的值之间是“或”的关系。无tags过滤条件时，默认认为这个标签搜索字段满足要求。最多包含10个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key-values结构中values的值之间不能重复。 tags_any 否 Array of tags 标签搜索字段。包含任意标签，结果返回满足tags_any搜索条件的共享资源列表。搜索条件中所有tag之间是“或”的关系，即只要有其中一个tag搜索条件满足要求时，共享资源便可以被搜索。每个tag搜索条件的key-values结构中values数组之间是“或”的关系。无tags_any过滤条件时，默认认为这个标签搜索字段满足要求。查询条件最多包含10个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key-values结构中values的值之间不能重复。 not_tags 否 Array of tags 标签搜索字段。不包含标签，结果返回满足not_tags搜索条件的共享资源列表，搜索条件中所有tag之间是“或非”的关系，即只有当所有tag搜索条件都不满足要求时，共享资源才可以被搜索。每个tag搜索条件的key-values结构中values数组的值之间是“或”的关系。无not_tags过滤条件时，默认认为这个标签搜索字段满足要求。最多包含10个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key-values结构中values的值之间不能重复。 not_tags_any 否 Array of tags 标签搜索字段。不包含任意标签，结果返回满足not_tags_any搜索条件的共享资源列表，查询条件中所有tag之间是“与非”的关系，即只要有一个tag搜索条件不满足要求时，共享资源便可以被搜索。每个tag搜索条件的key-values结构中values数组之间是“或”的关系。无not_tags_any过滤条件时，默认认为这个标签搜索字段满足要求。查询条件最多包含10个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key-values结构中values的值之间不能重复。 sys_tags 否 Array of tags 仅op_service权限可以使用此字段做资源实例过滤条件： 目前TMS调用时只包含一个tag结构体 key：_sys_enterprise_project_id。 目前TMS调用时key下面只包含一个value，0表示默认企业项目。 sys_tags和租户标签过滤条件（tags、tags_any、not_tags、not_tags_any）不能同时使用。 请求参数中，标签搜索字段tags/not_tags/tags_any/not_tags_any为非必选且可以任意自由组合，标签搜索字段tags/not_tags/tags_any/not_tags_any之间为“与”的关系。 match字段说明： 参数 是否必选 参数类型 描述 key 是 String 键。固定值为"resource_name"。 value 是 String 值。需要查询的共享的名称。value为空字符串时，精确匹配名称为空的共享，为非空字符串时模糊匹配（不区分大小写）。每个值最大长度为255个字符 。 tag字段说明： 参数 是否必选 参数类型 描述 key 是 String 标签的键。最大长度127个字符。 key不能为空。 values 是 Array of strings 值列表。每个值最大长度255个字符，如果values为空列表，则表示匹配任意值value。value之间为或的关系。 请求样例 根据标签查询共享实例个数，查询的共享名称为“share_name”,标签的键为“key1”，值为["value2"]。 { "action": "count", "matches": [{ "key": "resource_name", "value": "share_name" }], "tags": [{ "key": "key1", "values": ["value2"] }, { "key": "key2", "values": [] }], "tags_any": [{ "key": "key3", "values": ["value3"] }, { "key": "key4", "values": [] }], "not_tags": [{ "key": "key5", "values": ["value5"] }, { "key": "key6", "values": [] }], "not_tags_any": [{ "key": "key7", "values": ["value7", "value8"] }, { "key": "key9", "values": [] }] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 url 是 String ldap服务器的url base_dn 是 String 数据库中的域 user_dn 否 String 用户区别名 password 否 String ldap认证密码 vpc_id 否 String 一般不涉及。仅在SFSTurbo支持多VPC的场景下，需要指定LDAP服务器可连通的VPC的id。 filter_condition 否 String 过滤条件。保留字段，暂不支持

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 url String ldap服务器的url base_dn String 数据库中的域 user_dn String 用户区别名 filter_condition String 过滤条件。保留字段，暂不支持 状态码： 500 表4 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 查询成功 { "url" : "ldap://192.168.xx.xx:60000", "base_dn" : "dc=huawei,dc=com", "user_dn" : "cn=admin,dc=huawei,dc=com" } 状态码： 500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

修订记录 发布日期 修改记录 2023-08-15 第十二次正式发布。 本次更新说明如下： SFS Turbo API说明新增“权限管理”章节。 2023-04-21 第十一次正式发布。 本次更新说明如下： SFS Turbo API说明新增“文件系统管理”章节。 SFS Turbo API说明新增“目录管理”章节。 2022-08-29 第十次正式发布。 本次更新说明如下： 新增通用文件系统API相关内容。 2021-08-20 第九次正式发布。 本次更新说明如下： 新增SFS Turbo的“共享标签”章节。 2020-04-01 第八次正式发布。 本次更新说明如下： 删除基于策略的访问控制公测的相关内容。 2019-10-26 第七次正式发布 本次更新说明如下： SFS Turbo增加“共享标签”说明。 2019-05-06 第六次正式发布 本次更新说明如下： 新增“共享标签”章节。 2019-03-13 第五次正式发布 本次更新说明如下： 新增“SFS Turbo API 说明”下的“创建文件系统”章节。 新增“SFS Turbo API 说明”下的“删除文件系统”章节。 2019-02-25 第四次正式发布 本次更新说明如下： 新增“API授权项列表”章节。 支持企业项目功能，“接口简介”、“创建共享”、“查询所有共享”等章节增加相关参数和字段说明。 2018-12-11 第三次正式发布。 本次更新说明如下： 支持CIFS协议文件系统，增加相关参数和字段说明。 新增“查询所有共享的详细信息”和“查询单个实例”章节，增加SFS Turbo相关接口信息。 2018-11-02 第二次正式发布。 本次更新说明如下： 新增章节“查询API版本”，增加查询API版本的接口。 增加“查询API版本”章节版本说明。 增加“创建共享”章节metadata字段说明。 添加“共享访问规则”章节优化参数说明。 2017-09-23 第一次正式发布。

状态码 正常 202 异常 状态码 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

请求消息 参数说明 参数 是否必选 参数类型 描述 os-deny_access 是 Object os-deny_access对象。 当API的版本号在1.0-2.6之间时，请求体中JSON格式的body体中顶层参数使用"os-"前缀。如果需要使用的API版本大于2.6，则需要去掉"os-"前缀。 os-deny_access字段说明： 参数 是否必选 参数类型 描述 access_id 是 String 共享访问规则的ID,长度为1~36。 请求样例 删除共享访问规则，共享访问规则的ID为“418e3cf4-08c3-4ed2-a29a-ceffa346b3b8”。 { "os-deny_access": { "access_id": "418e3cf4-08c3-4ed2-a29a-ceffa346b3b8" } }

状态码 正常 200 异常 状态码 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。