更新时间:2024-03-05 GMT+08:00

添加共享访问规则

功能介绍

共享规则添加。

  • 该接口为异步接口,返回为200只是表示接口下发接收成功,后续可以通过查询共享访问规则接口,判断添加共享访问规则是否完成以及是否成功。

URI

  • POST /v2/{project_id}/shares/{share_id}/action?vpc_ip_base_acl={vpc_ip_base_acl}
  • 参数说明

    参数

    是否必选

    参数类型

    描述

    share_id

    String

    共享的ID。

    project_id

    String

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

    vpc_ip_base_acl

    String

    IP地址授权场景的标识符,当前可用值只有enable。值为enable时,表示创建IP地址授权场景的共享访问规则。

    须知:

    为了兼容性,当不设置该参数,或者设置了该参数但是值不为enable时,仍然可以使用接口创建IP地址授权场景的共享访问规则,但是,这种方式已废弃,且后续不再维护。

请求消息头

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

请求消息

  • 参数说明

    参数

    是否必选

    参数类型

    描述

    os-allow_access

    Object

    os-allow_access对象。

  • os-allow_access字段说明:

    参数

    是否必选

    参数类型

    描述

    access_level

    String

    共享访问的权限级别,取值为ro(只读),rw(读写)。默认为rw(读写)。

    access_type

    String

    访问存储的方式。

    • NFS协议文件共享只支持cert,
    • 多协议文件共享支持cert。

    说明

    1. 取值为user,指以用户名的方式访问存储,
    2. 取值为cert,指以VPCid+IP的方式访问存储。
  • 请求样例(按照IP地址授权的场景)

    POST /v2/{project_id}/shares/{share_id}/action?vpc_ip_base_acl=enable

    NFS共享:添加共享访问规则,共享访问的权限级别为读写,以VPCid+IP的方式访问存储,访问规则的值为“0560a527-0e77-40a6-aa3b-110beecad368#127.0.0.1#1#all_squash,root_squash”。

    { 
        "allow_access": { 
            "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#127.0.0.1#1#all_squash,root_squash", 
            "access_type": "cert", 
            "access_level": "rw" 
        } 
    }

    创建IP地址授权场景的共享访问规则时:

    1. 请求头需要指定X-Openstack-Manila-Api-Version参数,且X-Openstack-Manila-Api-Version的值需要为2.28到2.42之间的版本。

    2. 需要在请求URL中添加vpc_ip_base_acl参数且vpc_ip_base_acl的值需设置为enable。为了兼容性,当不设置该参数,或者设置了该参数但是值不为enable时,仍然可以使用接口创建IP地址授权场景的共享访问规则,但是,这种方式已废弃,且后续不再维护。

响应消息

  • 参数说明

    参数

    参数类型

    描述

    access

    Object

    access对象,如果共享访问规则未更新,这个值为null。

  • access字段说明:

    参数

    参数类型

    描述

    share_id

    String

    添加访问规则共享的ID。

    access_type

    String

    共享访问规则类型。

    access_to

    String

    后端允许或拒绝访问的对象。

    access_level

    String

    共享访问规则级别。

    id

    String

    共享访问规则的ID。

    state

    String

    共享访问规则的状态。API版本在2.28之前,共享访问规则的状态为new, active,或者error;在2.28到2.42之后的版本,共享访问规则的状态为queued_to_apply,applying, active, error, queued_to_deny或者 denying。

状态码

  • 正常

    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

    网关超时。