查询所有共享的详细信息。
接口也支持V1版本。
名称 | 类型 | IN | 必选 | 描述 |
---|---|---|---|---|
X-Auth-Token
|
string | header | 是 |
用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
X-Openstack-Manila-Api-Version
|
float | header | 否 |
指定微版本号 |
project_id
|
string | path | 是 |
操作用户的项目ID |
description
|
string | query | 否 |
通过共享描述信息模糊过滤。API 微版本2.36之后支持。 |
ent erp rise_project_id
|
string | query | 否 |
查询绑定某个企业项目的共享。 若需要查询当前用户所有企业项目绑定的共享,请使用all_granted_eps参数。 |
export_location_id
|
string | query | 否 |
通过共享挂载路径UUID过滤。API 微版本2.35之后支持。 |
export_location_path
|
string | query | 否 |
通过共享挂载路径过滤。API 微版本2.35之后支持。 |
is_public
|
boolean | query | 否 |
取值为true时,表示当前租户可以查询到自己的全部共享和其他租户is_public为true的共享,取值为false时,表示当前用户查询不到其他租户的共享。当前租户的共享,不受is_public参数的控制,全部都能查出来。 |
limit
|
integer | query | 否 |
返回的共享个数最大值,不指定该参数,默认全部返回。 |
metadata
|
string | query | 否 |
查询共享的metadata信息,由一到多个字典形式组织的键值对组成。 |
name
|
string | query | 否 |
通过共享名称模糊过滤。API 微版本2.36之后支持。 |
offset
|
integer | query | 否 |
共享查询个数从0开始的偏移量,必须大于等于0。 |
sort_dir
|
string | query | 否 |
共享列表的排序方向。可用的值有:asc(升序)和desc(降序)。 |
sort_key
|
string | query | 否 |
查询结果排序关键字。可用的值有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排序。 |
status
|
string | query | 否 |
通过共享状态过滤。可用的值有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。 |
with_count
|
string | query | 否 |
返回查询到的共享个数。API 微版本2.42之后支持。URI中使用?with_count=true指定,默认是false。 |
OK
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
count
|
string | 否 |
查询到共享的个数。 |
shares
|
Array of share_response objects | 是 |
详细参数说明请参考share_response字段说明。 |
查询所有共享详细信息