文档首页/ 弹性文件服务 SFS/ API参考/ SFS容量型API说明/ 文件共享/ 修改共享信息
更新时间：2024-03-05 GMT+08:00
查看PDF
分享

修改共享信息

功能介绍

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

URI

  • PUT /v2/{project_id}/shares/{share_id}
  • 参数说明

    参数

    是否必选

    参数类型

    描述

    share_id

    是

    String

    共享的ID。

    project_id

    是

    String

    操作用户的项目ID，获取方法请参见获取项目ID。

请求消息头

该操作消息头与普通请求一样，请参见表3。

请求消息

  • 参数说明

    参数

    是否必选

    参数类型

    描述

    share

    是

    Object

    share对象
  • share字段说明：

    参数

    是否必选

    参数类型

    描述

    display_name

    否

    String

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

    display_description

    否

    String

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

    is_public

    否

    Boolean

    （API 微版本2.8以后支持）共享的可见程度。设置为true时公共可见，设置为false时私有个人可见，默认值为false。
  • 请求样例
    修改共享信息，新的共享名称为“testshare”，共享描述信息为“test”。 
    {
    "share": {
        "display_name": "testshare",
        "display_description": "test"
    }
}

响应消息

  • 参数说明

    参数

    参数类型

    描述

    share

    Object

    share对象
  • share字段说明：

    参数

    参数类型

    描述

    links

    Array

    共享链接。

    availability_zone

    String

    可用区AZ(availability zone)。

    share_server_id

    String

    共享服务管理的ID。

    share_network_id

    String

    共享网络的ID，当前不支持共享网络管理，该字段无意义。

    snapshot_id

    String

    创建共享的源快照的ID，当前不支持快照，该字段当前无意义。

    snapshot_support

    Boolean

    是否支持快照，当前不支持快照，该字段当前无意义

    id

    String

    共享的ID。

    size

    Integer

    共享容量，单位GB。

    consistency_group_id

    String

    （API 微版本2.31到2.42支持）一致性组的ID，当前不支持一致性组，该字段当前无意义。

    project_id

    String

    创建共享的项目的ID。

    metadata

    Object

    一到多个字典形式组织的键值对。其中share_used作为key，对应的value表示共享已经使用的容量，单位是Bytes；enterprise_project_id作为key，对应的value是共享所属的企业项目ID。

    status

    String

    共享的状态。

    task_state

    String

    数据迁移状态，当前不支持数据迁移，该字段无意义。

    has_replicas

    Boolean

    （API 微版本2.11到2.42支持）是否有复制，当前不支持复制，该字段无意义。

    replication_type

    String

    （API 微版本2.11到2.42支持）复制类型，当前不支持复制，该字段无意义。

    description

    String

    共享描述。

    host

    String

    共享主机名。

    name

    String

    共享名称。

    created_at

    String

    共享创建的时间标签。

    access_rules_status

    String

    （API 微版本2.10-2.27之间支持）共享访问权限的设置结果，active表示已生效，error表示设置失败，syncing表示正在配置中。

    share_proto

    String

    文件系统的共享协议。

    volume_type

    String

    卷类型,，与share_type含义相同。

    share_type_name

    String

    共享类型的名称,共享类型用于指定分配哪些类型的存储服务，例如高性能类型（由SSD磁盘组成）、大容量类型（由SATA盘组成）。

    share_type

    String

    共享类型的ID。

    export_locations

    Array

    共享挂载路径信息列表，当前只支持有一个共享。当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.8，该字段存在，若为2.8到2.42之间，该消息不存在。

    export_location

    String

    共享挂载路径，当请求消息头指定的X-Openstack-Manila-Api-Version的值低于2.8，该字段存在，若为2.8到2.42之间，该消息不存在。

    is_public

    Boolean

    （API 微版本2.8到2.42支持）共享的可见程度。设置为true时公共可见，设置为false时私有个人可见，默认值为false。

    source_share_group_snapshot_member_id

    String

    （API 微版本2.31以后支持）一致性快照源的ID，当前不支持一致性快照，该字段无意义。

    revert_to_snapshot_support

    Boolean

    （API 微版本2.27以后支持）是否支持从快照回滚，目前不支持快照，该字段无意义。

    create_share_from_snapshot_support

    Boolean

    （API 微版本2.24以后支持）是否支持从快照创建共享，目前不支持快照，该字段无意义。

    mount_snapshot_support

    Boolean

    （API 微版本2.32以后支持）是否支持挂载快照，目前不支持快照，该字段无意义。

    user_id

    String

    （API 微版本2.16以后支持）用户ID。
  • 响应样例 
    {
  "share": {
    "status": "available",
    "share_type_name": "sla",
    "description": "test",
    "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"
      }
    ],
    "availability_zone": "az1.dc1",
    "share_network_id": null,
    "share_server_id": null,
    "share_group_id": null,
    "host": "DJ38@a4588256-3880-4136-b3c9-4c3aade8a84b#a4588256-3880-4136-b3c9-4c3aade8a84b",
    "revert_to_snapshot_support": null,
    "access_rules_status": "active",
    "snapshot_id": null,
    "create_share_from_snapshot_support": null,
    "is_public": true,
    "task_state": null,
    "snapshot_support": true,
    "id": "f26d867f-9876-433d-8db2-25d210f29309",
    "size": 1,
    "source_share_group_snapshot_member_id": null,
    "user_id": "daa3f8f8d7254465841da769298a76f6",
    "name": "manila share",
    "share_type": "8ae4e74e-83f4-4980-8ab8-e637f9294e0b",
    "has_replicas": false,
    "replication_type": null,
    "created_at": "2018-12-25T08:45:22.525899",
    "share_proto": "NFS",
    "volume_type": "sla",
    "mount_snapshot_support": null,
    "project_id": "07412155bf474db9a2f697fd978593d7",
    "metadata": {
      "share_key": "test",
      "share_used": "1",
    }
  }
}

状态码

  • 正常

    200

  • 异常

    状态码

    说明

    400 Bad Request

    服务器未能处理请求。

    401 Unauthorized

    被请求的页面需要用户名和密码。

    403 Forbidden

    对被请求页面的访问被禁止。

    404 Not Found

    服务器无法找到被请求的页面。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    406 Not Acceptable

    服务器生成的响应无法被客户端所接受。

    407 Proxy Authentication Required

    用户必须首先使用代理服务器进行验证，这样请求才会被处理。

    408 Request Timeout

    请求超出了服务器的等待时间。

    409 Conflict

    由于冲突，请求无法被完成。

    500 Internal Server Error

    请求未完成。服务异常。

    501 Not Implemented

    请求未完成。服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成。服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成。系统暂时异常。

    504 Gateway Timeout

    网关超时。
父主题： 文件共享