Reviewed-by: Miskanin, Jan <jan.miskanin@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>

2024-08-16 12:25:57 +00:00

15 KiB

Raw Blame History

Modifying a Permission Rule

Function

This API is used to modify a permission rule.

URI

PUT /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules/{rule_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
share_id	Yes	String	File system ID
rule_id	Yes	String	Permission rule ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Account token
Content-Type	Yes	String	MIME type

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
ip_cidr	No	String	IP address or IP address range of the object to be authorized. Once configured, this parameter cannot be modified.
rw_type	No	String	Read/write permission of the object to be authorized. rw: read and write permission, which is the default option ro: read-only permission none: no permission
user_type	No	String	File system access permission granted to the user of the object to be authorized. Supported values are: no_root_squash: allows any user including the root user on the client to access the file system as who they are, instead of mapping them to another user. root_squash: allows the root user on the client to access the file system as nfsnobody. all_squash: allows any user on the client to access the file system as nfsnobody.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Permission rule ID
ip_cidr	String	IP address or IP address range of the authorized object
rw_type	String	Read/write permission of the authorized object. rw: read and write permission, which is the default option ro: read-only permission none: no permission
user_type	String	File system access permission granted to the user of the authorized object. Supported values are: no_root_squash: allows the root user on the client to access the file system as root. root_squash: allows the root user on the client to access the file system as nfsnobody. all_squash: allows any user on the client to access the file system as nfsnobody. It is the default value.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
errCode	String	Error code Minimum: 8 Maximum: 36
errMsg	String	Error description Minimum: 2 Maximum: 512

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
errCode	String	Error code Minimum: 8 Maximum: 36
errMsg	String	Error description Minimum: 2 Maximum: 512

Example Requests

{
  "rw_type" : "rw",
  "user_type" : "no_root_squash"
}

Example Responses

Status code: 200

Successful creation

{
  "id" : "1131ed520xxxxxxebedb6e57xxxxxxxx",
  "ip_cidr" : "192.32.0.0/16",
  "rw_type" : "rw",
  "user_type" : "no_root_squash"
}

Status code: 400

Error response

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "Invalid rule id"
}

Status code: 500

Error response

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

Status Codes

Status Code	Description
200	Successful creation
400	Error response
500	Error response

Error Codes

See Error Codes.

Parent topic: Permissions Management

15 KiB Raw Blame History