Help Center/ Scalable File Service Turbo/ API Reference/ API/ Permissions Management/ Modifying a Permission Rule
Updated on 2025-11-14 GMT+08:00
View PDF

Modifying a Permission Rule

Function

This API is used to modify a permission rule.

Constraints

This API is only supported for NFS file systems.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

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

The project ID.

share_id

Yes

String

The file system ID.

rule_id

Yes

String

The permission rule ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The account token.

Content-Type

Yes

String

The MIME type.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

rw_type

No

String

The 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

The file system access permission granted to the user of the object to be authorized. The value can be:

  • no_root_squash (default value): allows any user including root on the client to access the file system as who they are, instead of mapping them to another user.

  • root_squash: allows root on the client to access the file system as nfsnobody and allows a non-root user on the client to access as who they are, instead of being mapped to another user.

  • 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

The permission rule ID.

ip_cidr

String

The IP address or IP address range of the authorized object.

rw_type

String

The 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

The file system access permission granted to the user of the authorized object. The value can be:

  • no_root_squash (default value): allows any user including root on the client to access the file system as who they are, instead of mapping them to another user.

  • root_squash: allows root on the client to access the file system as nfsnobody and allows a non-root user on the client to access as who they are, instead of being mapped to another user.

  • all_squash: allows any user on the client to access the file system as nfsnobody.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

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

Example Responses

Status code: 200

Success

{
  "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

Success

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Permissions Management