华为云计算 云知识 查询所有共享的详细信息listAllShareDetail
查询所有共享的详细信息listAllShareDetail

 

接口说明

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

约束说明

接口也支持V1版本。

URL
GET  https://sfs.cn-south-2.myhuaweicloud.com/v2/{project_id}/shares/detail 
请求参数
名称 类型 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之后支持。

enterprise_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。

返回参数
返回码: 200

OK

名称 类型 必选 描述
count
 
string

查询到共享的个数。

shares
 
Array of share_response objects

详细参数说明请参考share_response字段说明。

200 shares
名称 类型 必选 描述
access_rules_status
 
string

共享访问权限的设置结果,active表示已生效,error表示设置失败,syncing表示正在配置中。(API 微版本2.10以后支持)。

availability_zone
 
string

可用区AZ(availability zone)。

consistency_group_id
 
string

一致性组的UUID,当前不支持一致性组,该字段当前无意义。(API 微版本2.31到2.42以后支持)

create_share_from_snapshot_support
 
boolean

是否支持从快照创建共享,目前不支持快照,该字段无意义。(API 微版本2.24以后支持)。

created_at
 
string

共享创建的时间标签。

description
 
string

共享描述。

export_location
 
string

共享挂载路径,当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.9,该字段存在,若为2.9到2.42之间以后,该消息不存在。

export_locations
 
Array of strings

共享挂载路径信息列表,当前只支持有一个共享。当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.9,该字段存在,若为2.9到2.42之间以后,该消息不存在。

has_replicas
 
boolean

是否有复制,当前不支持复制,该字段无意义。(API 微版本2.11到2.42以后支持)。

host
 
string

共享主机名,管理员才会显示此字段。

id
 
string

共享的UUID。

is_public
 
boolean

共享的可见程度。设置为true时公共可见,设置为false时私有个人可见,默认值为false。

links
 
Array of links objects

共享链接。

metadata
 
metadata object

一到多个字典形式组织的键值对。其中share_used作为key,对应的value表示共享已经使用的容量,单位是Bytes;enterprise_project_id作为key,对应的value是共享所属的企业项目ID。

mount_snapshot_support
 
boolean

是否支持挂载快照,目前不支持快照,该字段无意义。(API 微版本2.32以后支持)。

name
 
string

共享名称。

project_id
 
string

创建共享的项目的UUID。

replication_type
 
string

复制类型,当前不支持复制,该字段无意义。(API 微版本2.11到2.42以后支持)。

revert_to_snapshot_support
 
boolean

是否支持从快照回滚,目前不支持快照,该字段无意义。(API 微版本2.27以后支持)。

share_network_id
 
string

共享网络的UUID,当前不支持共享网络管理,该字段无意义。

share_proto
 
string

文件系统的共享协议。

share_server_id
 
string

共享服务管理的UUID

share_type
 
string

共享类型的UUID。

share_type_name
 
string

共享类型的名称,共享类型用于指定分配哪些类型的存储服务,例如高性能类型(由SSD磁盘组成)、大容量类型(由SATA盘组成)。(API 微版本2.6以后支持)。

size
 
integer

共享容量,单位GB。

snapshot_id
 
string

创建共享的源快照的UUID,当前不支持快照,该字段当前无意义。

snapshot_support
 
boolean

是否支持快照,当前不支持快照,该字段当前无意义。(API 微版本2.2以后支持)。

source_share_group_snapshot_member_id
 
string

一致性快照源的UUID,当前不支持一致性快照,该字段无意义。(API 微版本2.31以后支持)。

status
 
string

共享的状态。

task_state
 
string

数据迁移 状态,当前不支持数据迁移,该字段无意义。(API 微版本2.5以后支持)

user_id
 
string

用户ID。(API 微版本2.16以后支持)。

volume_type
 
string

卷类型,,与share_type含义相同。

请求示例
示例 1

查询所有共享详细信息

 
"GET https://{endpoint}/v2/{project_id}/shares/detail"
 
"GET https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/detail"
错误码
请参考 错误码说明

 

上一篇:OCI容器规范 下一篇:负载均衡

致远互联协同管理解决方案实践

致远互联协同管理解决方案实践