华为云用户手册

状态码 正常 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字段说明： 参数 参数类型 描述 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，或者共享路径已经生成，说明创建已经成功。 通过该接口创建共享成功后，用户还需要参考添加共享访问规则添加共享访问规则，之后才可正常使用创建的共享。

请求消息 参数说明 参数 是否必选 参数类型 描述 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 }}

请求消息 参数说明 参数 是否必选 参数类型 描述 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": [] }]}

Console引用 权限 对应API接口 授权项 依赖的授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 更改安全组 Console引用 sfsturbo:shares:shareAction 更改安全组需要安全组相关权限： vpc:securityGroups:* vpc:securityGroupRules:* √ √ 查询sfs turbo配额 Console引用 sfsturbo:shares:getQuota - √ √ 获取可用区信息 Console引用 sfsturbo:shares:getAZInfo - √ √ 获取sfs turbo规格信息 Console引用 sfsturbo:shares:getFlavors - √ √ 检查文件系统名称 Console引用 sfsturbo:shares:checkShareName - √ √

文件系统 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 创建文件系统 POST /v1/{project_id}/sfs-turbo/shares sfsturbo:shares:createShare 创建SFS Turbo实例时，需要vpc相关权限，包括校验vpc、子网、安全组，创建vip以及port，创建安全组规则等，需要增加授权项： "vpc:*:*" 加密实例需要在项目上配置KMS Administrator权限 专属场景，需要增加授权项： "dss:*:get", "dss:*:list", "dss:*:count" √ √ 查询所有文件系统详细信息 GET /v1/{project_id}/sfs-turbo/shares/detail sfsturbo:shares:getAllShares - √ √ 查询单个文件系统详细信息 GET /v1/{project_id}/sfs-turbo/shares/{share_id} sfsturbo:shares:getShare - √ √ 删除文件系统 DELETE /v1/{project_id}/sfs-turbo/shares/{share_id} sfsturbo:shares:deleteShare 删除SFS Turbo实例时，需要vpc相关权限，包括删除vip以及port，删除安全组规则等，需要增加授权项： "vpc:*:*" 如果是专属场景，需要增加授权项： "dss:*:get", "dss:*:list", "dss:*:count" √ √ 创建文件系统异步任务 POST /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks sfsturbo:shares:createFsAsyncTask - √ √ 获取文件系统异步任务列表 GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks sfsturbo:shares:listFsAsyncTasks - √ √ 获取文件系统异步任务详情 GET /v1/{project_id}/sfs- turbo/shares/{share_id}/fs/{feature}/tasks/{task_id} sfsturbo:shares:showFsAsyncTask - √ √ 取消/删除文件系统异步任务 DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks/{task_id} sfsturbo:shares:deleteFsAsyncTask - √ √ 绑定后端存储 POST /v1/{project_id}/sfs-turbo/shares/{share_id}/targets sfsturbo:shares:createBackendTarget 用户需要额外配置OBS Adminstrator权限。 √ √ 查询后端存储列表 GET /v1/{project_id}/sfs-turbo/shares/{share_id}/targets sfsturbo:shares:listBackendTargets - √ √ 获取后端存储详细信息 GET /v1/{project_id}/sfs-turbo/shares/{share_id}/targets/{target_id} sfsturbo:shares:showBackendTargetInfo - √ √ 删除后端存储 DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/targets/{target_id} sfsturbo:shares:deleteBackendTarget - √ √ 创建数据导入导出任务 POST /v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/task sfsturbo:shares:createDataRepositoryTask - √ √ 查询数据导入导出任务详情 GET /v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/task/{task_id} sfsturbo:shares:getDataRepositoryTask - √ √ 查询数据导入导出任务列表 GET /v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/tasks sfsturbo:shares:getAllDataRepositoryTasks - √ √

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Date 是 String 请求消息时间 Authorization 是 String 请求签名信息 Host 是 String 表明主机地址。如filesystem.sfs3.cn-north-4.myhuaweicloud.com。 表3 请求Body参数 参数 是否必选 参数类型 描述 Statement 否 Array of Statement objects Unique identification 表4 Statement 参数 是否必选 参数类型 描述 Sid 否 String statement Id，描述statement的字符串 Action 是 String 本条statement作用的操作，取值范围：FullControl（读写）、Read（只读）。 枚举值： FullControl Read Effect 是 String 效果，指定本条statement的权限是允许，必须为Allow。 枚举值： Allow Condition 是 Condition object 本条statement生效的条件。 表5 Condition 参数 是否必选 参数类型 描述 SourceVpc 是 String 指定VPC的VPCid。 VpcSourceIp 否 Array of strings 指定的IP或IP范围（暂不支持该参数）。

请求示例 设置文件系统ACL，授予读写权限，VPC ID为“241dbf6b-dc5d-41b2-9108-ca5e56b48386”，IP范围为["127.0.0.1/24", "192.168.1.85/24"]。 PUT /?sfsacl HTTP/1.1Host: examplefilesystem.sfs3.cn-north-4.myhuaweicloud.comDate: WED, 01 Jul 2015 02:32:25 GMTAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:jZiAT8Vx4azWEvPRMWi0X5BpJMA={"Statement": [{"Sid": "Stmt1375240018061","Action": "FullControl","Effect": "Allow","Condition": {"SourceVpc": "241dbf6b-dc5d-41b2-9108-ca5e56b48386","VpcSourceIp": ["127.0.0.1/24", "192.168.1.85/24"]}}]}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-obs-bucket-type 是 String 通过此消息头明确获取的列表内容。 取值： SFS：获取所有文件系统列表。 枚举值： SFS Authorization 是 String 签名信息 Date 是 String 请求时间 Host 是 String 表明主机地址。如sfs3.cn-north-4.myhuaweicloud.com。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 Owner Owner object 文件系统拥有者信息，包含租户ID Buckets Buckets object 用户所拥有的文件系统列表 表3 Owner 参数 参数类型 描述 ID String 用户的DomainID（账号ID） 表4 Buckets 参数 参数类型 描述 Bucket Bucket object 具体的文件系统信息 表5 Bucket 参数 参数类型 描述 Name String 文件系统名称 CreationDate String 文件系统的创建时间 Location String 文件系统的位置信息

创建共享 如下示例是创建文件共享最简单的配置。 { "share": { "description": "test description", "share_type": "default", "name": "share_London", "metadata": { "key1": "value1", "key2": "value2" }, "share_proto": "NFS", "size": 10, "is_public": false }} description：文件共享的描述，可以通过描述对文件共享添加备注。 share_type：共享类型的名称，共享类型用于指定分配哪些类型的存储服务。 share_proto：文件共享协议类型。 name：文件共享的名称，由您自行定义，例如取名为share_London。 size：文件共享大小，单位GB。 is_public：共享的可见程度。设置为true时公共可见，设置为false时私有个人可见，默认值为false。 metadata：共享的metadata信息，一到多个字典形式组织的键值对组成。

创建加密的共享 您还可以为文件共享进行加密，只需在请求消息体的metadata中增加与加密共享相关的参数即可，示例如下。 { "share": { "share_type": null, "name": "test", "snapshot_id": null, "description": "test description", "metadata": { "#sfs_crypt_key_id": "9130c90d-73b8-4203-b790-d49f98d503df", "#sfs_crypt_domain_id": "3b2d9670690444c582942801ed7d457b", "#sfs_crypt_alias": "sfs/default" }, "share_proto": "NFS", "share_network_id": null, "size": 1, "is_public": false }} #sfs_crypt_key_id：加密密钥ID，该字段与“#sfs_crypt_domain_id”和“#sfs_crypt_alias”字段同时存在时表示启动数据加密功能。 #sfs_crypt_domain_id：租户的Domain id，该字段与“#sfs_crypt_key_id”和“#sfs_crypt_alias”字段同时存在时表示启动数据加密功能。 #sfs_crypt_alias：加密密钥别名，该字段与“#sfs_crypt_key_id”和“#sfs_crypt_domain_id”字段同时存在时表示启动数据加密功能。

Java中Content-MD5的计算方法示例 1 2 3 4 5 6 7 8 910111213141516171819 import java.security.MessageDigest;import sun.misc.BASE64Encoder;import java.io.UnsupportedEncodingException;import java.security.NoSuchAlgorithmException;public class Md5{ public static void main(String[] args) { try { String exampleString = "blog"; MessageDigest messageDigest = MessageDigest.getInstance("MD5"); BASE64Encoder encoder = new BASE64Encoder(); String contentMd5 = encoder.encode(messageDigest.digest(exampleString.getBytes("utf-8"))); System.out.println("Content-MD5：" + contentMd5); } catch (NoSuchAlgorithmException | UnsupportedEncodingException e) { e.printStackTrace(); } }}

状态码 正常 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" } ]}

响应消息 参数说明 参数 参数类型 描述 share Object share对象 share字段说明： 参数 参数类型 描述 links Array 共享链接。 availability_zone String 可用区AZ(availability zone)。 share_server_id String 共享服务管理的ID share_network_id String 共享网络的ID，当前不支持共享网络管理，该字段无意义。 snapshot_id String 创建共享的源快照的ID，当前不支持快照，该字段当前无意义。 snapshot_support Boolean 是否支持快照，当前不支持快照，该字段当前无意义。（API 微版本2.2以后支持）。 id String 共享的ID。 size Integer 共享容量，单位GB。 consistency_group_id String 一致性组的ID，当前不支持一致性组，该字段当前无意义。（API 微版本2.31到2.42支持） project_id String 创建共享的项目的ID。 metadata Object 一到多个字典形式组织的键值对。其中share_used作为key，对应的value表示共享已经使用的容量，单位是Bytes。SFS容量型文件系统已用容量小于1MB时，将不会显示已用容量。enterprise_project_id作为key，对应的value是共享所属的企业项目ID。 status String 共享的状态。 task_state String 数据迁移状态，当前不支持数据迁移，该字段无意义。（API 微版本2.5以后支持） has_replicas Boolean 是否有复制，当前不支持复制，该字段无意义。（API 微版本2.11到2.42支持）。 replication_type String 复制类型，当前不支持复制，该字段无意义。（API 微版本2.11到2.42支持）。 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": "available", "share_type_name": "sla", "description": "My custom share London", "links": [ { "href": "https://192.168.196.47:8796/v2/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309", "rel": "self" }, { "href": "https://192.168.196.47:8796/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309", "rel": "bookmark" } ], "availability_zone": "az1.dc1", "share_network_id": null, "share_server_id": null, "share_group_id": null, "host": "DJ38@a4588256-3880-4136-b3c9-4c3aade8a84b#a4588256-3880-4136-b3c9-4c3aade8a84b", "revert_to_snapshot_support": null, "access_rules_status": "active", "snapshot_id": null, "create_share_from_snapshot_support": null, "is_public": false, "task_state": null, "snapshot_support": true, "id": "f26d867f-9876-433d-8db2-25d210f29309", "size": 1, "source_share_group_snapshot_member_id": null, "user_id": "daa3f8f8d7254465841da769298a76f6", "name": "luzhongguo_1", "share_type": "8ae4e74e-83f4-4980-8ab8-e637f9294e0b", "has_replicas": false, "replication_type": null, "created_at": "2018-12-25T08:45:22.525899", "share_proto": "NFS", "volume_type": "sla", "mount_snapshot_support": null, "project_id": "07412155bf474db9a2f697fd978593d7", "metadata": { "share_key": "test", "share_used": "1", } }}

状态码 正常 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 网关超时。

状态码 正常 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 网关超时。

响应消息 参数说明 参数 参数类型 描述 quota_set Object quota_set对象。 quota_set字段说明： 参数 参数类型 描述 gigabytes Integer 租户允许的容量大小。 snapshots Integer 租户允许的快照数量。 shares Integer 租户允许的共享数量。 snapshot_gigabytes Integer 租户允许的快照容量大小。 id String 阈值对应租户的ID。 share_networks Integer 租户允许的共享网络数量。 响应样例 { "quota_set": { "gigabytes": -1, "snapshots": -1, "snapshot_gigabytes": -1, "shares": -1, "id": "da0f615c35eb4d72812d1547a77b5394", "share_networks": 10 }}

状态码 正常 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 网关超时。

请求消息 参数说明 参数 是否必选 参数类型 描述 os-allow_access 是 Object os-allow_access对象。 当API的版本号在1.0-2.6之间时，请求体中JSON格式的body体中顶层参数使用"os-"前缀。如果需要使用的API版本大于2.6，则需要去掉"os-"前缀。 os-allow_access字段说明： 参数 是否必选 参数类型 描述 access_level 否 String 共享访问的权限级别，取值为ro（只读），rw（读写）。默认为rw（读写）。 access_type 是 String 访问存储的方式。 NFS协议文件共享只支持cert， 多协议文件共享支持cert。 说明 取值为user，指以用户名的方式访问存储， 取值为cert，指以VPCid+IP的方式访问存储。 access_to 是 String 定义访问规则的值。根据场景取值： 如果access_type为user，则取值为AK。 如果access_type为cert： 按照VPC授权的场景，填写VPCID。 按照IP地址授权的场景进行填写： 如果是NFS共享，填写格式为“VPCID#IP#优先级#用户权限”，其中VPCID、IP、优先级和用户权限字段之间使用“#”分隔，例如“0157b53f-4974-4e80-91c9-098532bcaf00#2.2.2.2/16#100#all_squash,root_squash”。。 如果是多协议共享，填写格式为“#协议类型#访问存储的方式# VPCID#IP#优先级#用户权限”，例如“#NFS#IP#07207b50-61b4-4e40-b272-e5433105c2d0#1.1.1.1#1#no_all_squash,no_root_squash” 说明： VPCID、IP、优先级和用户权限的说明与限制： VPCID：VPC的ID。 IP：E CS 主网口上的租户IPv4地址或IPv4地址段。一条规则只支持设置一个IPv4地址或IPv4地址段，使用掩码形式表示一个地址段，如192.168.1.0-192.168.1.255的地址段的格式为192.168.1.0/24，不支持192.168.1.0-255等其他地址段表示形式。输入的IPv4地址/地址段必须合法，且不能为除0.0.0.0/0以外之前0开头的IP地址或地址段，其中当设置为0.0.0.0/0时表示VPC内的任意IP。同时，不能为127以及224~255开头的IP地址或地址段，例如127.0.0.1，224.0.0.1，255.255.255.255，其中以224-239开头的IP地址或地址段是属于D类地址，用于组播；以240-255开头的IP地址或地址段属于E类地址，用于研究。使用非合法的IP或IP地址段可能会导致添加访问规则失败或者添加的访问规则无法生效。 优先级：共享访问规则的优先级。优先级只能是0-100的整数。0表示优先级最高，100表示优先级最低。同一VPC内挂载时会优先使用该优先级高的IP地址/地址段所拥有的权限，存在相同优先级时会随机匹配其中一个IP地址/地址段。例如：用户在执行挂载操作时的IP地址为10.1.1.32，而在已经授权的IP地址/地址段中10.1.1.32（读写）和10.1.1.0/24（只读）均符合要求，则此时会先使用两个地址/地址段中优先级较高的权限。 用户权限：格式为“allSquash,rootSquash”。allSquash和rootSquash之间的权限设置用“,”分隔。allSquash的取值为“all_squash”或“no_all_squash”，rootSquash的取值包括"root_squash"或"no_root_squash"。 须知： 创建IP地址授权的场景的共享访问规则时，API的microversions需要是2.28以及之后的版本，且需要在请求URL中添加vpc_ip_base_acl参数，详细请参考下述的请求样例（按照IP地址授权的场景）。 属于VPC A中的弹性云服务器IP地址可以被成功添加至VPC B的授权IP地址内，但该云服务器无法挂载属于VPC B下的文件系统。弹性云服务器和文件系统所使用的VPC需为同一个。

URI POST /v2/{project_id}/shares/{share_id}/action?vpc_ip_base_acl={vpc_ip_base_acl} 参数说明 参数 是否必选 参数类型 描述 share_id 是 String 共享的ID。 project_id 是 String 操作用户的项目ID，获取方法请参见获取项目ID。 vpc_ip_base_acl 否 String IP地址授权场景的标识符，当前可用值只有enable。值为enable时，表示创建IP地址授权场景的共享访问规则。 须知： 为了兼容性，当不设置该参数，或者设置了该参数但是值不为enable时，仍然可以使用接口创建IP地址授权场景的共享访问规则，但是，这种方式已废弃，且后续不再维护。

响应消息 参数说明 参数 参数类型 描述 access Object access对象，如果共享访问规则未更新，这个值为null。 access字段说明： 参数 参数类型 描述 share_id String 添加访问规则共享的ID。 access_type String 共享访问规则类型。 access_to String 后端允许或拒绝访问的对象。 access_level String 共享访问规则级别。 id String 共享访问规则的ID。 state String 共享访问规则的状态。API版本在2.28之前，共享访问规则的状态为new, active,或者error；在2.28到2.42之后的版本，共享访问规则的状态为queued_to_apply,applying, active, error, queued_to_deny或者 denying。 access_key String 访问规则的访问凭据。请求消息头指定的X-Openstack-Manila-Api-Version的值大于等于2.21到2.42时，该字段才存在。

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

状态码 正常 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 网关超时。

响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 详细的公共响应消息头字段请参见表1。 表1 公共响应消息头 消息头名称 描述 Content-Length 响应消息体的字节长度。 类型：字符串。 默认值：无。 Connection 指明与服务器的连接是长连接还是短连接。 类型：字符串。 有效值：keep-alive | close。 默认值：无。 Date 系统响应的时间。 类型：字符串。 默认值：无。 x-obs-id-2 帮助定位问题的特殊符号。 类型：字符串。 默认值：无。 x-obs-request-id 由SFS创建来唯一确定本次请求的值，可以通过该值来定位问题。 类型：字符串。 默认值：无。

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。 弹性文件服务支持的自定义策略授权项如下所示： 【示例】文件共享，包含SFS所有文件系统接口对应的授权项，如创建文件系统、查询文件系统列表、查询单个文件系统详情、修改文件系统、删除文件系统等接口。 【示例】扩容缩容，包括SFS文件系统扩容缩容接口对应的授权项，如扩容共享和缩容共享等接口。 【示例】SFS Turbo授权项分类，包含SFS Turbo所有文件系统接口对应的授权项，如创建文件系统、查询文件系统列表、查询单个文件系统详情、删除文件系统等接口。

响应消息 参数说明 参数 参数类型 描述 tags Array of resource_tags tag标签的列表。 sys_tags Array of resource_tags 仅op_service权限才可以获取此字段： 目前只包含一个resource_tag结构体 key：_sys_enterprise_project_id 目前key下面只包含一个value，0表示默认企业项目。 非op_service场景不能返回此字段。 resource_tag字段说明： 参数 参数类型 描述 key String 标签的键。 value String 标签的值。 响应样例 { "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "" } ]}

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