華為云計(jì)算 云知識(shí) 查詢所有共享的詳細(xì)信息listAllShareDetail
查詢所有共享的詳細(xì)信息listAllShareDetail
時(shí)間: 2023-08-24 16:15:08
猜你想看：
實(shí)時(shí)語(yǔ)音識(shí)別 云服務(wù)器配置 CDN是什么意思 視頻點(diǎn)播加速 什么是云桌面

 

接口說(shuō)明

查詢所有共享的詳細(xì)信息。

約束說(shuō)明

接口也支持V1版本。

URL
GET  https://sfs.cn-south-2.myhuaweicloud.com/v2/{project_id}/shares/detail 
請(qǐng)求參數(shù)
名稱 類(lèi)型 IN 必選 描述
X-Auth-Token
 
 string header 是

用戶Token。

通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。
X-Openstack-Manila-Api-Version
 
 float header 否

指定微版本號(hào)
project_id
 
 string path 是

操作用戶的項(xiàng)目ID
description
 
 string query 否

通過(guò)共享描述信息模糊過(guò)濾。API 微版本2.36之后支持。
enterprise_project_id
 
 string query 否

查詢綁定某個(gè)企業(yè)項(xiàng)目的共享。 若需要查詢當(dāng)前用戶所有企業(yè)項(xiàng)目綁定的共享,請(qǐng)使用all_granted_eps參數(shù)。
export_location_id
 
 string query 否

通過(guò)共享掛載路徑UUID過(guò)濾。API 微版本2.35之后支持。
export_location_path
 
 string query 否

通過(guò)共享掛載路徑過(guò)濾。API 微版本2.35之后支持。
is_public
 
 boolean query 否

取值為true時(shí),表示當(dāng)前租戶可以查詢到自己的全部共享和其他租戶is_public為true的共享,取值為false時(shí),表示當(dāng)前用戶查詢不到其他租戶的共享。當(dāng)前租戶的共享,不受is_public參數(shù)的控制,全部都能查出來(lái)。
limit
 
 integer query 否

返回的共享個(gè)數(shù)最大值,不指定該參數(shù),默認(rèn)全部返回。
metadata
 
 string query 否

查詢共享的metadata信息,由一到多個(gè)字典形式組織的鍵值對(duì)組成。
name
 
 string query 否

通過(guò)共享名稱模糊過(guò)濾。API 微版本2.36之后支持。
offset
 
 integer query 否

共享查詢個(gè)數(shù)從0開(kāi)始的偏移量,必須大于等于0。
sort_dir
 
 string query 否

共享列表的排序方向?？捎玫闹涤?asc(升序)和desc(降序)。
sort_key
 
 string query 否

查詢結(jié)果排序關(guān)鍵字?？捎玫闹涤衖d, 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。默認(rèn)按照created_at排序。
status
 
 string query 否

通過(guò)共享狀態(tài)過(guò)濾?？捎玫闹涤衏reating, 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 否

返回查詢到的共享個(gè)數(shù)。API 微版本2.42之后支持。URI中使用?with_count=true指定,默認(rèn)是false。
返回參數(shù)
返回碼: 200

OK

名稱 類(lèi)型 必選 描述
count
 
 string 否

查詢到共享的個(gè)數(shù)。
shares
 
 Array of share_response objects 是

詳細(xì)參數(shù)說(shuō)明請(qǐng)參考share_response字段說(shuō)明。
200 shares
名稱 類(lèi)型 必選 描述
access_rules_status
 
 string 否

共享訪問(wèn)權(quán)限的設(shè)置結(jié)果,active表示已生效,error表示設(shè)置失敗,syncing表示正在配置中。(API 微版本2.10以后支持)。
availability_zone
 
 string 是

可用區(qū)AZ(availability zone)。
consistency_group_id
 
 string 否

一致性組的UUID,當(dāng)前不支持一致性組,該字段當(dāng)前無(wú)意義。(API 微版本2.31到2.42以后支持)
create_share_from_snapshot_support
 
 boolean 否

是否支持從快照創(chuàng)建共享,目前不支持快照,該字段無(wú)意義。(API 微版本2.24以后支持)。
created_at
 
 string 否

共享創(chuàng)建的時(shí)間標(biāo)簽。
description
 
 string 否

共享描述。
export_location
 
 string 否

共享掛載路徑,當(dāng)請(qǐng)求消息頭指定的X-Openstack-Manila-Api-Version的值低于2.9,該字段存在,若為2.9到2.42之間以后,該消息不存在。
export_locations
 
 Array of strings 否

共享掛載路徑信息列表,當(dāng)前只支持有一個(gè)共享。當(dāng)請(qǐng)求消息頭指定的X-Openstack-Manila-Api-Version的值低于2.9,該字段存在,若為2.9到2.42之間以后,該消息不存在。
has_replicas
 
 boolean 否

是否有復(fù)制,當(dāng)前不支持復(fù)制,該字段無(wú)意義。(API 微版本2.11到2.42以后支持)。
host
 
 string 否

共享主機(jī)名,管理員才會(huì)顯示此字段。
id
 
 string 是

共享的UUID。
is_public
 
 boolean 否

共享的可見(jiàn)程度。設(shè)置為true時(shí)公共可見(jiàn),設(shè)置為false時(shí)私有個(gè)人可見(jiàn),默認(rèn)值為false。
links
 
 Array of links objects 否

共享鏈接。
metadata
 
 metadata object 否

一到多個(gè)字典形式組織的鍵值對(duì)。其中share_used作為key,對(duì)應(yīng)的value表示共享已經(jīng)使用的容量,單位是Bytes;enterprise_project_id作為key,對(duì)應(yīng)的value是共享所屬的企業(yè)項(xiàng)目ID。
mount_snapshot_support
 
 boolean 否

是否支持掛載快照,目前不支持快照,該字段無(wú)意義。(API 微版本2.32以后支持)。
name
 
 string 否

共享名稱。
project_id
 
 string 是

創(chuàng)建共享的項(xiàng)目的UUID。
replication_type
 
 string 否

復(fù)制類(lèi)型,當(dāng)前不支持復(fù)制,該字段無(wú)意義。(API 微版本2.11到2.42以后支持)。
revert_to_snapshot_support
 
 boolean 否

是否支持從快照回滾,目前不支持快照,該字段無(wú)意義。(API 微版本2.27以后支持)。
share_network_id
 
 string 否

共享網(wǎng)絡(luò)的UUID,當(dāng)前不支持共享網(wǎng)絡(luò)管理,該字段無(wú)意義。
share_proto
 
 string 否

文件系統(tǒng)的共享協(xié)議。
share_server_id
 
 string 否

共享服務(wù)管理的UUID
share_type
 
 string 否

共享類(lèi)型的UUID。
share_type_name
 
 string 否

共享類(lèi)型的名稱,共享類(lèi)型用于指定分配哪些類(lèi)型的存儲(chǔ)服務(wù),例如高性能類(lèi)型(由SSD磁盤(pán)組成)、大容量類(lèi)型(由SATA盤(pán)組成)。(API 微版本2.6以后支持)。
size
 
 integer 是

共享容量,單位GB。
snapshot_id
 
 string 否

創(chuàng)建共享的源快照的UUID,當(dāng)前不支持快照,該字段當(dāng)前無(wú)意義。
snapshot_support
 
 boolean 否

是否支持快照,當(dāng)前不支持快照,該字段當(dāng)前無(wú)意義。(API 微版本2.2以后支持)。
source_share_group_snapshot_member_id
 
 string 否

一致性快照源的UUID,當(dāng)前不支持一致性快照,該字段無(wú)意義。(API 微版本2.31以后支持)。
status
 
 string 否

共享的狀態(tài)。
task_state
 
 string 否

數(shù)據(jù)遷移 狀態(tài),當(dāng)前不支持?jǐn)?shù)據(jù) 遷移 ,該字段無(wú)意義。(API 微版本2.5以后支持)
user_id
 
 string 否

用戶ID。(API 微版本2.16以后支持)。
volume_type
 
 string 否

卷類(lèi)型,,與share_type含義相同。
請(qǐng)求示例
示例 1

查詢所有共享詳細(xì)信息

 
"GET https://{endpoint}/v2/{project_id}/shares/detail"
 
"GET https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/detail"
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說(shuō)明。

 

查詢所有共享的詳細(xì)信息listAllShareDetail

意見(jiàn)反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會(huì)繼續(xù)努力做到更好 反饋提交失??！請(qǐng)稍后重試！