查询所有共享的详细信息

功能介绍

查询所有共享的详细信息。

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之后支持。

请求消息头

该操作消息头与普通请求一样，请参见表3。

请求消息

• 参数说明

  无

• 请求样例

  无

响应消息

• 参数说明

  参数	参数类型	描述
  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	网关超时。