華為云計算 云知識 添加共享訪問規(guī)則allowAccess
添加共享訪問規(guī)則allowAccess

 

接口說明

共享規(guī)則添加。

約束說明

? 該接口為異步接口,返回為200只是表示接口下發(fā)接收成功,后續(xù)可以通過"查詢共享訪問規(guī)則接口",判斷添加共享訪問規(guī)則是否完成以及是否成功。 ? API的microversions從2.28到2.42以后版本,支持添加共享訪問規(guī)則時忽略已存在的訪問規(guī)則的錯誤狀態(tài)。API的microversions通過請求頭的X-Openstack-Manila-Api-Version參數(shù)指定。

URL
POST  https://sfs.cn-south-2.myhuaweicloud.com/v2/{project_id}/shares/{share_id}/action 
請求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
string header

用戶Token。

通過調(diào)用 IAM 服務獲取用戶Token接口獲取(響應消息頭中X-Subject-Token的值)。

X-Openstack-Manila-Api-Version
 
float header

指定微版本號。

project_id
 
string path

操作用戶的項目ID。

share_id
 
string path

共享的UUID。

vpc_ip_base_acl
 
string query

IP地址授權場景的標識符,當前可用值只有enable。值為enable時,表示創(chuàng)建IP地址授權場景的共享訪問規(guī)則。 須知 為了兼容性,當不設置該參數(shù),或者設置了該參數(shù)但是值不為enable時,仍然可以使用接口創(chuàng)建IP地址授權場景的共享訪問規(guī)則,但是,這種方式已廢棄,且后續(xù)不再維護

Body參數(shù)
名稱 類型 必選 描述
allow_access
 
os-allow_access object  
參數(shù):
allow_access
名稱 類型 必選 描述
access_level
 
string

共享訪問的權限級別,取值為ro(只讀),rw(讀寫)。默認為rw(讀寫)。

access_to
 
string

定義訪問規(guī)則的值,長度為1~255。根據(jù)場景取值:

  1. 按照VPC授權的場景,填寫VPCID。
  2. 按照IP地址授權的場景進行填寫: ? 如果是NFS共享, 填寫格式為“VPCID#IP#優(yōu)先級#用戶權限”,其中VPCID、IP、優(yōu)先級和用戶權限字段之間使用“#”分隔,例如“0157b53f-4974-4e80-91c9-098532bcaf00#2.2.2.2/16#100#all_squash,root_squash”。 ? 如果是CIFS共享,填寫格式為“VPCID#IP#優(yōu)先級”。例如“0157b53f-4974-4e80-91c9-098532bcaf00#2.2.2.2/16#0”。
access_type
 
string

共享訪問規(guī)則的類型,NFS、CIFS共享。

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

Accepted

名稱 類型 必選 描述
access
 
access object

access對象,如果共享訪問規(guī)則未更新,這個值為null。

202 access
名稱 類型 必選 描述
access_key
 
string

訪問規(guī)則的訪問憑據(jù)。請求消息頭指定的X-Openstack-Manila-Api-Version的值大于等于2.21到2.42時,該字段才存在。

access_level
 
string

共享訪問規(guī)則級別。

access_to
 
string

后端允許或拒絕訪問的對象。

access_type
 
string

共享訪問規(guī)則類型。

created_at
 
string

共享訪問規(guī)則的創(chuàng)建時間。請求消息頭指定的X-Openstack-Manila-Api-Version的值大于等于2.33時,該字段才存在。

id
 
string

共享訪問規(guī)則的UUID。

share_id
 
string

添加訪問規(guī)則共享的UUID。

state
 
string

共享訪問規(guī)則的狀態(tài)。API版本在2.28之前,共享訪問規(guī)則的狀態(tài)為new, active,或者error;在2.28到到2.42之后的版本,共享訪問規(guī)則的狀態(tài)為queued_to_apply,applying, active, error, queued_to_deny或者 denying。

updated_at
 
string

共享訪問規(guī)則的更新時間。請求消息頭指定的X-Openstack-Manila-Api-Version的值大于等于2.33時,該字段才存在。

請求示例
示例 1

NFS共享添加訪問規(guī)則

 
"POST /v2/{project_id}/shares/{share_id}/action?vpc_ip_base_acl=enable"
 
{ "allow_access": { "access_level": "rw", "access_to": "0560a527-0e77-40a6-aa3b-110bee cad 368#0.0.0.0/0#1#all_squash,root_squash", "access_type": "cert" } }
示例 2

CIFS共享添加訪問規(guī)則

 
"POST /v2/{project_id}/shares/{share_id}/action?vpc_ip_base_acl=enable"
 
{ "allow_access": { "access_level": "rw", "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#0.0.0.0/0#0", "access_type": "cert" } }
返回示例
返回碼:202

Accepted

示例 1
 
{
"access": {
"access_key": null,
"access_level": "rw",
"access_to": "0560a527-0e77-40a6-aa3b-110beecad368#0.0.0.0/0#1#all_squash,root_squash",
"access_type": "cert",
"created_at": "2017-07-07T03:15:06.858662",
"id": "24615391-d58d-4a74-ac5a-520233c9c396",
"share_id": "7ec1115f-518b-40ff-a998-5599ce2da332",
"state": "queued_to_apply",
"updated_at": "2018-07-07T03:15:06.858662"
}
}
錯誤碼
請參考 錯誤碼說明。