華為云計(jì)算 云知識(shí) 創(chuàng)建共享createShare
創(chuàng)建共享createShare

 

接口說明

創(chuàng)建文件共享。創(chuàng)建文件系統(tǒng)成功后,您還需前往彈性 云服務(wù)器 執(zhí)行掛載操作,才能實(shí)現(xiàn)多個(gè)云服務(wù)器共享文件存儲(chǔ)

約束說明
  • 該接口為異步接口,返回為200只是表示接口下發(fā)接收成功,后續(xù)可以通過6.2.4 查詢共享詳細(xì)信息查詢共享的共享狀態(tài)和共享路徑,判斷創(chuàng)建共享是否完成以及是否成功,如果共享狀態(tài)變?yōu)閍vailable,或者共享路徑已經(jīng)生成,說明創(chuàng)建已經(jīng)成功。
  • 通過該接口創(chuàng)建共享成功后,用戶還需要參考接口"添加共享訪問規(guī)則添加共享訪問規(guī)則",之后才可正常使用創(chuàng)建的共享。
URL
POST  https://sfs.cn-south-2.myhuaweicloud.com/v2/{project_id}/shares 
請(qǐng)求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
string header

用戶Token。

通過調(diào)用 IAM 服務(wù)獲取用

X-Openstack-Manila-Api-Version
 
float header

指定API微版本號(hào)

project_id
 
string path

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

Body參數(shù)
名稱 類型 必選 描述
share
 
share object

詳見share字段說明

參數(shù):
share
名稱 類型 必選 描述
availability_zone
 
string

AZ( availability zone)的名稱,如果不輸入AZ信息,后臺(tái)會(huì)當(dāng)成默認(rèn)AZ處理,默認(rèn)AZ中如果無(wú)存儲(chǔ)資源,共享創(chuàng)建會(huì)失敗。長(zhǎng)度為0~255。

consistency_group_id
 
string

(API 微版本2.31到2.42之后支持) 共享將創(chuàng)建到的一致性組的UUID。當(dāng)前文件服務(wù)不支持一致性組,該字段無(wú)意義,這個(gè)參數(shù)不填寫。

description
 
string

共享描述信息,長(zhǎng)度為0~255,只支持英文字母、數(shù)字、中劃線、下劃線。

is_public
 
boolean

(API 微版本2.8到2.42之后支持)共享的可見程度。設(shè)置為true時(shí)公共可見,設(shè)置為false時(shí)私有個(gè)人可見,默認(rèn)值為false。

metadata
 
Map<String,String>

創(chuàng)建共享的metadata信息,一到多個(gè)字典形式組織的鍵值對(duì)組成,見share_metadata字段說明。

name
 
string

共享名稱,長(zhǎng)度為0~255,只支持英文字母、數(shù)字、中劃線、下劃線。

share_network_id
 
string

共享服務(wù)所屬或即將創(chuàng)建到的共享網(wǎng)絡(luò)的UUID,長(zhǎng)度為0~36,當(dāng)前不支持共享網(wǎng)絡(luò)管理,該字段無(wú)意義。

share_proto
 
string

文件系統(tǒng)共享協(xié)議,有效值為NFS(適用于linux系統(tǒng))、CIFS(適用于windows系統(tǒng))。

share_type
 
string

共享類型的名稱,共享類型用于指定分配哪些類型的存儲(chǔ)服務(wù),例如高性能類型(由SSD磁盤組成)、大容量類型(由SATA盤組成),當(dāng)前支持一種類型的存儲(chǔ)服務(wù),用戶不用指定本參數(shù),后臺(tái)會(huì)自動(dòng)把本參數(shù)指定為系統(tǒng)支持的存儲(chǔ)類型,用戶若要輸入系統(tǒng)不支持的服務(wù)類型,將導(dǎo)致文件服務(wù)申請(qǐng)失敗。

size
 
integer

共享容量,單位GB。申請(qǐng)的共享容量不能大于配額值,需要查看配額。

snapshot_id
 
string

創(chuàng)建共享的源快照的UUID,長(zhǎng)度為0~36,當(dāng)前不支持快照,該字段無(wú)意義。

返回參數(shù)
返回碼: 202

Accepted

名稱 類型 必選 描述
share
 
share_response object

詳細(xì)參數(shù)說明請(qǐng)參見share_response字段說明

202 share
名稱 類型 必選 描述
access_rules_status
 
string

共享訪問權(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

共享的可見程度。設(shè)置為true時(shí)公共可見,設(shè)置為false時(shí)私有個(gè)人可見,默認(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ù)制類型,當(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

共享類型的UUID。

share_type_name
 
string

共享類型的名稱,共享類型用于指定分配哪些類型的存儲(chǔ)服務(wù),例如高性能類型(由SSD磁盤組成)、大容量類型(由SATA盤組成)。(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

卷類型,,與share_type含義相同。

請(qǐng)求示例
示例 1

創(chuàng)建共享

 
"POST https://{endpoint}/v2/{project_id}/shares"
 
{ "share": { "description": "test description", "is_public": false, "metadata": { "key1": "value1", "key2": "value2" }, "name": "test", "share_network_id": null, "share_proto": "NFS", "share_type": null, "size": 1, "snapshot_id": null } }
返回示例
返回碼:202

Accepted

示例 1
 
{
"share": {
"availability_zone": "az1.dc1",
"created_at": "2015-09-18T10:25:24.533287",
"description": "My custom share London",
"export_location": null,
"export_locations": [],
"host": null,
"id": "011d21e2-fbc3-4e4a-9993-9ea223f73264",
"is_public": true,
"links": [
{
"href": "http://192.168.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264",
"rel": "self"
},
{
"href": "http://192.168.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264",
"rel": "bookmark"
}
],
"metadata": {
"aim": "doc",
"project": "my_app"
},
"name": "share_London",
"project_id": "16e1ab15c35a457e9c2b2aa189f544e1",
"share_network_id": null,
"share_proto": "NFS",
"share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7",
"size": 1,
"snapshot_id": null,
"status": "creating",
"volume_type": "default"
}
}
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說明