查询所有共享

功能介绍

列举出所有的文件共享的基础信息。

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参数。

请求消息头

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

请求消息

• 参数说明

  无

响应消息

• 参数说明

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