華為云計(jì)算 云知識 查詢所有共享listAllShare
查詢所有共享listAllShare

 

接口說明

列舉出所有的文件共享的基礎(chǔ)信息。

約束說明

接口也支持V1版本。

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

用戶Token。

通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。

X-Openstack-Manila-Api-Version
 
float header

指定微版本號

project_id
 
string path

操作用戶的項(xiàng)目ID

description
 
string query

通過共享描述信息模糊過濾。API 微版本2.36之后支持。

enterprise_project_id
 
string query

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

export_location_id
 
string query

通過共享掛載路徑UUID過濾。API 微版本2.35之后支持。

export_location_path
 
string query

通過共享掛載路徑過濾。API 微版本2.35之后支持。

is_public
 
boolean query

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

limit
 
integer query

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

metadata
 
string query

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

name
 
string query

通過共享名稱模糊過濾。API 微版本2.36之后支持。

offset
 
integer query

共享查詢個(gè)數(shù)從0開始的偏移量,必須大于等于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

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

名稱 類型 必選 描述
count
 
string

查詢到共享的個(gè)數(shù)。

shares
 
Array of share_response_simple objects

詳細(xì)參數(shù)說明請參考share_response_simple字段說明。

200 shares
名稱 類型 必選 描述
id
 
string

共享的UUID。

links
 
Array of links objects

共享請求鏈接信息。

name
 
string

共享的名稱。

請求示例
示例 1

查詢所有共享

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