华为云计算 云知识 修改共享updateShare
修改共享updateShare

 

接口说明

修改共享的描述和名称信息。

约束说明

兼容V1接口

URL
PUT  https://sfs.cn-south-2.myhuaweicloud.com/v2/{project_id}/shares/{share_id} 
请求参数
名称 类型 IN 必选 描述
X-Auth-Token
 
string header

用户Token。

通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

X-Openstack-Manila-Api-Version
 
float header

指定微版本号

project_id
 
string path

操作用户的项目ID。

share_id
 
string path

共享的UUID。

Body参数
名称 类型 必选 描述
share
 
share_update object

share对象

参数:
share
名称 类型 必选 描述
display_description
 
string

可选的共享描述信息,长度为0~255。

display_name
 
string

新的共享名称,长度为0~255。

is_public
 
boolean

(API 微版本2.8以后支持)共享的可见程度。设置为true时公共可见,设置为false时私有个人可见,默认值为false。

返回参数
返回码: 200

OK

名称 类型 必选 描述
share
 
share_response object

share对象

200 share
名称 类型 必选 描述
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;ent erp rise_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

修改共享

 
"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"
}
}
错误码
请参考 错误码说明

 

上一篇:免费SSL证书 下一篇:幻兽帕鲁服务器存档丢失怎么办

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

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

伙伴方案
公有云/HCSO/HCS