華為云計(jì)算 云知識(shí) 修改共享updateShare
修改共享updateShare

 

接口說(shuō)明

修改共享的描述和名稱(chēng)信息。

約束說(shuō)明

兼容V1接口

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

用戶(hù)Token。

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

X-Openstack-Manila-Api-Version
 
float header

指定微版本號(hào)

project_id
 
string path

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

share_id
 
string path

共享的UUID。

Body參數(shù)
名稱(chēng) 類(lèi)型 必選 描述
share
 
share_update object

share對(duì)象

參數(shù):
share
名稱(chēng) 類(lèi)型 必選 描述
display_description
 
string

可選的共享描述信息,長(zhǎng)度為0~255。

display_name
 
string

新的共享名稱(chēng),長(zhǎng)度為0~255。

is_public
 
boolean

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

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

OK

名稱(chēng) 類(lèi)型 必選 描述
share
 
share_response object

share對(duì)象

200 share
名稱(chēng) 類(lèi)型 必選 描述
access_rules_status
 
string

共享訪(fǎng)問(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

共享名稱(chēng)。

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)型的名稱(chēng),共享類(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

用戶(hù)ID。(API 微版本2.16以后支持)。

volume_type
 
string

卷類(lèi)型,,與share_type含義相同。

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

修改共享

 
"PUT https://{endpoint}/v2/{project_id}/shares/{share_id}"
 
{ "share": { "display_description": "test", "display_name": "testshare" } }
返回示例
返回碼:200

OK

示例 1
 
{
"share": {
"access_rules_status": "active",
"availability_zone": "az1.dc1",
"create_share_from_snapshot_support": null,
"created_at": "2018-12-25T08:45:22.525899",
"description": "test",
"has_replicas": false,
"host": "DJ38@a4588256-3880-4136-b3c9-4c3aade8a84b#a4588256-3880-4136-b3c9-4c3aade8a84b",
"id": "f26d867f-9876-433d-8db2-25d210f29309",
"is_public": true,
"links": [
{
"href": "https://192.168.196.47:8796/v2/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309",
"rel": "self"
},
{
"href": "https://192.168.196.47:8796/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309",
"rel": "bookmark"
}
],
"metadata": {
"enterprise_project_id": "ttt",
"share_key": "test",
"share_used": "1"
},
"mount_snapshot_support": null,
"name": "manila share",
"project_id": "07412155bf474db9a2f697fd978593d7",
"replication_type": null,
"revert_to_snapshot_support": null,
"share_group_id": null,
"share_network_id": null,
"share_proto": "NFS",
"share_server_id": null,
"share_type": "8ae4e74e-83f4-4980-8ab8-e637f9294e0b",
"share_type_name": "sla",
"size": 1,
"snapshot_id": null,
"snapshot_support": true,
"source_share_group_snapshot_member_id": null,
"status": "available",
"task_state": null,
"user_id": "daa3f8f8d7254465841da769298a76f6",
"volume_type": "sla"
}
}
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說(shuō)明。