华为云用户手册

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

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

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

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

请求消息 参数说明 参数 是否必选 参数类型 描述 os-access_list 是 Object os-access_list对象，查询访问规则时，这个值设为null。 当API的版本号在1.0-2.6之间时，请求体中JSON格式的body体中顶层参数使用"os-"前缀。如果需要使用的API版本大于2.6，则需要去掉"os-"前缀。 请求样例 { "os-access_list": null }

响应消息 说明 参数 参数类型 描述 access_list Array of objects 共享访问规则列表。 access_list字段说明： 参数 参数类型 描述 access_type String 共享访问规则的类型。 access_to String 后端允许或拒绝访问的对象。 access_level String 共享访问规则的级别。 state String 共享访问规则的状态。API版本在2.28之前，共享访问规则的状态为new, active,或者error；在2.28到2.42之后的版本，共享访问规则的状态为queued_to_apply,applying, active, error, queued_to_deny或者 denying。 id String 共享访问规则的ID。 响应样例 { "access_list": [ { "access_level": "rw", "state": "active", "id": "85417bed-5e26-4c99-8c0c-92c95b5c640e", "access_type": "cert", "access_to": "a91556b7-c7c8-4273-915e-2729e04cdb01", }, { "access_level": "rw", "state": "active", "id": "2ecbeb0b-b2ba-41f1-ba63-0666548925b9", "access_type": "cert", "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#0.0.0.0/0#0#all_squash,root_squash", "created_at": "2017-07-07T03:15:06.858662", "updated_at": "2018-07-07T03:15:06.858662" }, { "access_level": "rw", "state": "active", "id": "24615391-d58d-4a74-ac5a-520233c9c396", "access_type": "cert", "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#192.168.196.47#1#all_squash,root_squash", } ] }

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

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

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

响应消息 参数说明 参数 参数类型 描述 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", } } }

状态码 正常 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字段说明： 参数 是否必选 参数类型 描述 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" } }

功能介绍 查询共享挂载路径信息。 必须在请求头中指定X-Openstack-Manila-Api-Version的值大于等于2.9，该接口才存在。用curl命令发送请求的示例如下：curl -k -i -X GET https://192.168.196.47:8786/v2/13c7ff9a479c4e3599f4331d9e4a1835/shares/2a8c5470-d5d9-4fe1-b9fc-66a15a162e41/export_locations -H "X-Openstack-Manila-Api-Version: 2.9" -H "X-Auth-Token: $token" -H "Accept: application/json"

响应消息 参数说明 参数 参数类型 描述 export_locations Array of strings export_location对象的列表 export_location字段说明： 参数 参数类型 描述 id String 共享的挂载路径的ID。 share_instance_id String 共享实例的ID。 path String 挂载共享时要使用的路径。 is_admin_only Boolean 是否仅管理员和创建的属主可见，如果是true表明只有创建属主用户和具有管理员身份的用户可见，如果是false，表明所有用户都可见。 preferred Boolean 当挂载路径有多个时候，标记这个挂载路径，是否应该优先使用。 响应样例 NFS共享： { "export_locations": [ { "path": "NFS:sfs-nas1.dong.com:/share-236b936a", "id": "b03d2aac-aeed-409a-af07-5d1b9024241c", "preferred": false } ] }

状态码 正常 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 是否支持快照，当前不支持快照，该字段当前无意义。（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", } } }

响应消息 参数说明 参数 参数类型 描述 shares Array of objects 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。 响应样例 { "shares": [ { "links": [ { "href": "https://192.168.170.97:8796/v2/61b01a94b84448cfac2424e46553d7e7/shares/54d0bac6-45c8-471c-bf0d-16ffd81ef88a", "rel": "self" }, { "href": "https://192.168.170.97:8796/61b01a94b84448cfac2424e46553d7e7/shares/54d0bac6-45c8-471c-bf0d-16ffd81ef88a", "rel": "bookmark" } ], "export_location": "sfs.dong.com:/share-e1c2d35e", "availability_zone": "az1.dc1", "share_network_id": null, "snapshot_id": null, "id": "54d0bac6-45c8-471c-bf0d-16ffd81ef88a", "size": 1, "share_type": "default", "consistency_group_id": null, "project_id": "da0f615c35eb4d72812d1547a77b5394", "metadata": { "share_used": "1048576000000", }, "status": "available", "description": "test description", "export_locations": ["sfs.dong.com:/share-e1c2d35e"], "host": "DJ01@9656beb1-7ce2-4c46-9911-ecd51ab632bf#9656beb1-7ce2-4c46-9911-ecd51ab632bf", "is_public": false, "name": "cl01", "created_at": "2017-07-07T03:15:06.858662", "share_proto": "NFS", "volume_type": "default" } ] }

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

URI GET /v2/{project_id}/shares/detail?all_tenants={all_tenants}&project_id={project_id}&status={status}&limit={limit}&offset={offset}&sort_key={sort_key}&sort_dir={sort_dir}&is_public={is_public}&name={name} 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID，获取方法请参见获取项目ID。 all_tenants 否（查询参数） Integer (管理员权限)。是否显示所有租户的共享。1表示全部租户。0表示只显示当前租户。 project_id 否（查询参数） String 创建共享的租户的ID。该参数配合all_tenants使用时用。 status 否（查询参数） String 通过共享状态过滤。可用的值有：creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error和shrinking_possible_data_loss_error。 limit 否（查询参数） Integer 返回的共享个数最大值。 offset 否（查询参数） Integer 共享查询个数的偏移量。 sort_key 否（查询参数） String 查询结果排序关键字。可用的值有：id, status, size, host, share_proto, availability_zone_id, user_id, project_id, created_at, updated_at, display_name, name, share_type_id, share_network_id, snapshot_id。 sort_dir 否（查询参数） String 共享列表的排序方向。可用的值有：asc（升序）和desc（降序）。 is_public 否（查询参数） String 取值为true时，表示当前租户可以查询到自己的全部共享和其他租户is_public为true的共享，取值为false时，表示当前用户查询不到其他租户的共享。当前租户的共享，不受is_public参数的控制，全部都能查出来。 enterprise_project_id 否（查询参数） String 查询绑定某个企业项目的共享。 若需要查询当前用户所有企业项目绑定的共享，请使用all_granted_eps参数。 name 否（查询参数） String 通过共享名称模糊过滤。API 微版本2.36之后支持。

URI GET /v2/{project_id}/shares?all_tenants={all_tenants}&status={status}&limit={limit}&offset={offset}&sort_key={sort_key}&sort_dir={sort_dir}&project_id={project_id}&is_public={is_public} 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID，获取方法请参见获取项目ID。 all_tenants 否（查询参数） Boolean 该参数仅支持管理员权限用户使用。是否显示所有租户的共享。1表示全部租户。0表示只显示当前租户。 project_id 否（查询参数） String 该参数仅支持管理员权限用户使用。创建共享的项目的ID。需要参数配合all_tenants使用。 status 否（查询参数） String 通过共享状态过滤。参数取值如下： creating：正在创建共享 error：共享创建失败 available：共享可以使用 deleting：共享正在被删除 error_deleting：共享删除失败 extending：共享正在扩容 extending_error：共享扩容失败 shrinking：共享正在缩容 shrinking_error：共享缩容失败 shrinking_possible_data_loss_error：因数据丢失导致共享缩容失败 manage_starting：共享管理开始 manage_error：共享管理错误 unmanage_starting： 共享取消管理开始 unmanage_error：共享不受管理错误 unmanaged：共享不受管理 limit 否（查询参数） Integer 返回的共享个数最大值，不指定该参数，默认全部返回。 offset 否（查询参数） Integer 共享查询个数从0开始的偏移量，必须大于等于0。 sort_key 否（查询参数） String 查询结果排序关键字。可用的值有id, status, size, host, share_proto, availability_zone_id, user_id, project_id, created_at, updated_at, display_name, name, share_type_id, share_network_id, snapshot_id。默认按照created_at排序。 sort_dir 否（查询参数） String 共享列表的排序方向。可用的值有：asc（升序）和desc（降序）。 is_public 否（查询参数） String 取值为true时，表示当前租户可以查询到自己的全部共享和其他租户is_public为true的共享，取值为false时，表示当前用户查询不到其他租户的共享。当前租户的共享，不受is_public参数的控制，全部都能查出来。 enterprise_project_id 否（查询参数） String 查询绑定某个企业项目的共享。 若需要查询当前用户所有企业项目绑定的共享，请使用all_granted_eps参数。

响应消息 参数说明 参数 参数类型 描述 shares Array of objects 详细参数说明请参考share字段说明。 share字段说明： 参数 参数类型 描述 id String 共享的ID。 links Array of objects 共享请求链接信息。 name String 共享的名称。 响应样例 { "shares": [ { "id": "1390cb29-539b-4926-8953-d8d6b106071a", "links": [ { "href": "https://192.168.196.47:8796/v2/f24555bfcf3146ca936d21bcb548687e/shares/1390cb29-539b-4926-8953-d8d6b106071a", "rel": "self" }, { "href": "https://192.168.196.47:8796/f24555bfcf3146ca936d21bcb548687e/shares/1390cb29-539b-4926-8953-d8d6b106071a", "rel": "bookmark" } ], "name": null } ] }

状态码 正常 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 由于冲突，请求无法被完成。 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 } }

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