华为云用户手册

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

响应消息 参数说明 参数 参数类型 描述 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 是否支持快照，当前不支持快照，该字段当前无意义 id String 共享的ID。 size Integer 共享容量，单位GB。 consistency_group_id String （API 微版本2.31到2.42支持）一致性组的ID，当前不支持一致性组，该字段当前无意义。 project_id String 创建共享的项目的ID。 metadata Object 一到多个字典形式组织的键值对。其中share_used作为key，对应的value表示共享已经使用的容量，单位是Bytes；enterprise_project_id作为key，对应的value是共享所属的企业项目ID。 status String 共享的状态。 task_state String 数据迁移状态，当前不支持数据迁移，该字段无意义。 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 共享创建的时间标签。 access_rules_status String （API 微版本2.10-2.27之间支持）共享访问权限的设置结果，active表示已生效，error表示设置失败，syncing表示正在配置中。 share_proto String 文件系统的共享协议。 volume_type String 卷类型,，与share_type含义相同。 share_type_name String 共享类型的名称,共享类型用于指定分配哪些类型的存储服务，例如高性能类型（由SSD磁盘组成）、大容量类型（由SATA盘组成）。 share_type String 共享类型的ID。 export_locations Array 共享挂载路径信息列表，当前只支持有一个共享。当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.8，该字段存在，若为2.8到2.42之间，该消息不存在。 export_location String 共享挂载路径，当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.8，该字段存在，若为2.8到2.42之间，该消息不存在。 is_public Boolean （API 微版本2.8到2.42支持）共享的可见程度。设置为true时公共可见，设置为false时私有个人可见，默认值为false。 source_share_group_snapshot_member_id String （API 微版本2.31以后支持）一致性快照源的ID，当前不支持一致性快照，该字段无意义。 revert_to_snapshot_support Boolean （API 微版本2.27以后支持）是否支持从快照回滚，目前不支持快照，该字段无意义。 create_share_from_snapshot_support Boolean （API 微版本2.24以后支持）是否支持从快照创建共享，目前不支持快照，该字段无意义。 mount_snapshot_support Boolean （API 微版本2.32以后支持）是否支持挂载快照，目前不支持快照，该字段无意义。 user_id String （API 微版本2.16以后支持）用户ID。 响应样例 { "share": { "status": "available", "share_type_name": "sla", "description": "test", "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": true, "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": "manila share", "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", } } }

请求消息 参数说明 参数 是否必选 参数类型 描述 share 是 Object share对象 share字段说明： 参数 是否必选 参数类型 描述 display_name 否 String 新的共享名称，长度为0~255。 display_description 否 String 可选的共享描述信息，长度为0~255。 is_public 否 Boolean （API 微版本2.8以后支持）共享的可见程度。设置为true时公共可见，设置为false时私有个人可见，默认值为false。 请求样例 修改共享信息，新的共享名称为“testshare”，共享描述信息为“test”。 { "share": { "display_name": "testshare", "display_description": "test" } }

状态码 正常 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时，该字段才存在。

SFS Turbo错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400/404 SFS.TURBO.0001 Parameter error 参数错误 请使用合法的参数重试。 400/404 SFS.TURBO.0002 Cluster not found 对象不存在或没有权限 请使用合法的参数重试。 400 SFS.TURBO.0003 Invalid name 名称不符合规则 请使用合法的参数重试。 400 SFS.TURBO.0004 Invalid vpc 指定的vpc无效 请使用合法的参数重试。 400/500 SFS.TURBO.0005 Internal server error 内部错误 请联系技术支持。 400 SFS.TURBO.0006 Invalid subnet 指定的subnet无效 请使用合法的参数重试。 400 SFS.TURBO.0007 Invalid share type 文件系统类型不合法 请使用合法的参数重试。 400 SFS.TURBO.0008 Invalid size 文件系统大小不在支持的范围内 请使用合法的参数重试。 409 SFS.TURBO.0009 Name has existed 文件系统名称已经存在 请使用合法的参数重试。 400 SFS.TURBO.0010 Quota exceeds 配额不足 请提工单扩大配额。 400/403 SFS.TURBO.0011 Cluster is doing something 该文件正在进行其它操作，无法执行该操作，请稍后重试 等待其他操作完成，然后进行重试 400 SFS.TURBO.0012 Operation is not allowed 包周期文件系统不支持通过API进行扩容、删除操作。 请在控制台进行包周期文件系统的管理。 400 SFS.TURBO.0015 do not have the operation permission 没有操作权限 请申请相关权限 400 SFS.TURBO.0016 Res tag count already reach max value 资源标签达到上限 删除无用标签 400 SFS.TURBO.0017 Invalid tag key param 资源标签key长度非法 请使用合法的参数重试。 400 SFS.TURBO.0018 Invalid tag value param 资源标签value长度非法 请使用合法的参数重试。 404 SFS.TURBO.0019 Invalid Job Id 指定的job id不存在 请使用合法的job id 400 SFS.TURBO.0020 Invalid flavor 指定的flavor不存在 请使用合法的flavor 400 SFS.TURBO.0021 file system not match 类型不匹配，同一实例类型不满足磁盘一致性 请确保同一实例类型满足磁盘一致性 400 SFS.TURBO.0022 backup name already exists 备份名称已经存在 请更换备份名称 400 SFS.TURBO.0023 Invalid flavor ref 规格码非法 请使用合法的规格码 400 SFS.TURBO.0024 Operation is not allowed 该文件系统不支持该操作，请联系技术支持 请联系技术支持。 400 SFS.TURBO.0025 Invalid tag key param 资源标签key含有非法字符 请使用合法的参数重试。 400 SFS.TURBO.0026 Invalid tag value param 资源标签value含有非法字符 请使用合法的参数重试。 400 SFS.TURBO.0027 Invalid security group 指定的安全组无效 请使用合法的参数重试。 400 SFS.TURBO.0028 Invalid crypt key 指定的密钥无效 请使用合法的参数重试。 400 SFS.TURBO.0029 Subnet has not enough ips 子网可用IP不足 请使用合法的参数重试。 400 SFS.TURBO.0030 Ecs resource not enough ECS资源不足，该规格在选择的AZ售罄 请更换可用区重试。 400 SFS.TURBO.0031 cache type not exist cache_type不存在 请使用合法的cache_type 400 SFS.TURBO.0032 EVS Resource Not Enough 云盘资源不足 请扩充云盘资源 500 SFS.TURBO.0033 Get Client Ips Error 获取客户端IP失败 请重新获取客户端IP，如果问题无法解决，请及时联系技术支持 400 SFS.TURBO.0034 dedicated storage resource not enough 专属存储池资源不足 请扩充专属存储池资源 400 SFS.TURBO.0035 The current type does not support backup. 当前类型不支持备份 当前类型不支持备份 500 SFS.TURBO.0036 Failed to obtain the used capacity of the directory 获取目录使用容量失败 请重新获取目录使用容量，如果问题无法解决请及时联系技术支持 400 SFS.TURBO.0037 Operation conflict, client retry 操作冲突，客户端重试 请使用合法的操作 400 SFS.TURBO.0038 unknown error 未知错误 请联系技术支持 400 SFS.TURBO.0039 The VIP quota is insufficient vip配额不足 请申请更多的VIP配额 400 SFS.TURBO.0040 Insufficient Security Group Quota 安全组配额不足 请增加安全组配额 400 SFS.TURBO.0041 Operation is not allowed 文件系统版本较低，不支持该操作 请联系技术支持 404 SFS.TURBO.0042 Invalid NIC ID 指定的NIC ID不存在或为空 请使用合法的参数重试 400 SFS.TURBO.0100 Invalid file system path 文件系统路径非法 请使用合法的文件系统路径 404 SFS.TURBO.0101 The file system path does not exist 文件系统路径不存在 请选择合法的文件系统路径 400 SFS.TURBO.0102 The file system path is not a directory 文件系统路径非目录 请选择合法的文件系统路径 400 SFS.TURBO.0103 The file system is being processed 文件系统正在处理中 请等待文件系统处理完成 500 SFS.TURBO.0104 Failed to import or export OBS data obs导入导出操作失败 请重新导入导出obs，若问题未解决，请联系技术支持 500 SFS.TURBO.0105 Failed to obtain OBS import and export task data 获取obs导入导出任务数据失败 请重新获取obs导入导出的数据，如果问题未得到解决，请联系技术支持 400 SFS.TURBO.0106 The OBS task does not exist obs 任务不存在 请选择存在的obs任务或者创建相应的obs任务 400 SFS.TURBO.0107 OBS protocol error 配置后端type参数错误 请联系技术支持 400 SFS.TURBO.0108 The OBS endpoint name is incorrect obs 域名错误 请联系技术支持 400 SFS.TURBO.0109 The OBS bucket name is incorrect obs 桶名错误 请使用合法的obs桶名 400 SFS.TURBO.0110 OBS agent error 导入导出任务失败 请联系技术支持 400 SFS.TURBO.0111 The OBS configuration list is empty obs 配置列表为空 请使用合法的obs配置信息 父主题： 附录

响应消息 参数说明 参数 参数类型 描述 versions Array of objects 所有可用的API版本列表对象，包含v1和v2。 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" } ] }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 任务类型，当前支持import(附加元数据导入)，import_metadata(快速导入)，preload(数据预热)，export(导出)。 附加元数据导入方式会导入OBS对象的元数据（名称、大小、最后修改时间）以及来源于SFS Turbo 导出时的附加元数据（如uid、gid、mode）。 快速导入方式仅会导入OBS对象的元数据（名称、大小、最后修改时间），不会导入其它附加元数据（如uid、gid、mode），SFS Turbo会生成默认的附加元数据（uid:0、gid:0、目录权限:755、文件权限:644）。 数据预热功能会同时导入元数据和数据内容，数据预热中的元数据导入采用快速导入方式，不会导入其它附加元数据（如uid、gid、mode）。 数据导出功能会将您在联动目录里创建的文件，以及对从OBS导入后又做过修改的文件导出存储到OBS桶里。 枚举值： import export import_metadata preload src_target 是 String 联动目录名称 src_prefix 否 String 导入导出任务的源端路径前缀，导入时不需要包含OBS桶名，导出时不需要包含联动目录名称。 对于数据预热导入，携带源端路径前缀时必须是以“/”结尾的目录或具体到某个对象。 如果不带该字段，导入时会导入绑定OBS桶内的所有对象，导出时会导出联动目录下的所有文件。 dest_target 是 String 目前只支持和src_target保持一致 dest_prefix 否 String 目前只支持和src_prefix保持一致

响应参数 状态码： 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 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表9 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 202 Accepted { "task_id" : "7bd2a9b6-xxxx-4605-xxxx-512d636001b0" } 状态码： 400 客户端错误 { "errCode" : "SFS.TURBO.0001", "errMsg" : "parameter error" } 状态码： 500 内部错误 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

请求示例 创建附加元数据导入任务，任务类型是"import"，联动目录名称是"sfs-link-directory"，关联OBS桶内的源端路径前缀是"input/datasets/"。 { "type" : "import", "src_target" : "sfs-link-directory", "src_prefix" : "input/datasets/", "dest_target" : "sfs-link-directory", "dest_prefix" : "input/datasets/" }

具体示例 在已获取token的前提下，curl命令创建SFS Turbo文件系统的具体实例： curl -k -i -X POST -H "X-Auth-Token: token_value" -H "Content-Type: application/json" -d '{"share": {"name": "sfs-turbo-test", "share_proto": "NFS", "share_type": "STANDARD", "size": 100, "availability_zone": "az1", "vpc_id": "d651ea2b-2b20-4c6d-8bbf-2adcec18dac9", "subnet_id": "b8884abe-f47b-4917-9f6c-f64825c365db", "security_group_id": "8c4ebbd0-6edf-4aae-8353-81ce6d06e1f4"}}' "https://127.0.0.1:8979/v1/xxxbxbex5cfx41f0a08ay915fd79240d/sfs-turbo/shares"

具体步骤 获取Token ，具体操作请参考认证鉴权 。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下： { "share": { "name": "sfs-turbo-test", "share_proto": "NFS", "share_type": "STANDARD", "size": 100, "availability_zone": "az1", "vpc_id": "d651ea2b-2b20-4c6d-8bbf-2adcec18dac9", "subnet_id": "b8884abe-f47b-4917-9f6c-f64825c365db", "security_group_id": "8c4ebbd0-6edf-4aae-8353-81ce6d06e1f4" } } 发送请求“POST https://SFS Turbo的Endpoint/v1/{project_id}/sfs-turbo/shares”。 请求响应成功后，返回SFS Turbo文件系统的id和name。 若请求失败，则会返回错误码及对应的错误信息说明，详细错误码信息请参考对应API接口的异常返回值。 根据返回的文件系统id查询SFS Turbo文件系统详情，具体操作请参考查询文件系统详细信息。 查询文件系统详情返回状态status为“200”，则表示创建SFS Turbo文件系统成功。请求异常的返回值说明请参考对应API接口的异常返回值。其他的状态请参考SFS Turbo文件系统状态。 根据文件系统的id，可对SFS Turbo文件系统进行查询、删除等操作。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 path String 目录全路径 mode Long 目录权限，仅20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型文件系统返回该字段。第三位表示目录所有者的权限，第四位表示目录所属用户组的权限，第五位表示其他用户的权限。目录所有者由uid指定，目录所属用户组由gid指定，不是目录所有者且不在目录所属用户组的用户为其他用户。例如：40755中第三位7代表目录所有者对该目录具有读、写、执行权限；第四位5代表目录所属用户组对该目录具有读、执行权限；第五位5代表其他用户对该目录具有读、执行权限。 最小值：0 uid Long 目录所有者的用户id，仅20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型文件系统返回该字段。 最小值：0 gid Long 目录所属用户组id，仅20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型文件系统返回该字段。 最小值：0 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 查询目录结果 { "path" : "/date/test" } 状态码： 400 错误响应 { "errCode" : "SFS.TURBO.0100", "errMsg" : "invalid path" } 状态码： 404 错误响应，目录不存在 { "errCode" : "SFS.TURBO.0101", "errMsg" : "path not exist" } 状态码： 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 网关超时。

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

响应示例 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

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

状态码 正常 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" } } 客户端收到系统响应时，共享创建任务还未结束，因此，共享路径不能马上查询到，当创建任务完成后，用户可以通过共享路径信息查询接口查询出来。

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

功能介绍 创建文件共享。创建文件系统成功后，您还需前往弹性云服务器执行挂载操作，才能实现多个云服务器共享文件存储。挂载相关操作请参考弹性文件服务快速入门。 该接口为异步接口，返回为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