Help Center/ Scalable File Service/ API Reference/ SFS Turbo APIs/ Permissions Management/ Querying a Permission Rule of a File System
Updated on 2024-11-13 GMT+08:00
View PDF

Querying a Permission Rule of a File System

Function

This API is used to query a specific permission rule of a file system.

URI

GET /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

Response Parameters

Status code: 200

Table 3 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 4 Response body parameters

Parameter

Type

Description

errCode

String

Error code

errMsg

String

Error description

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Error code

errMsg

String

Error description

Example Requests

Querying details about the permission rule whose ID is 11abef677ac40f46644d1d5cfc2424a4 for the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde

GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/perm-rules/11abef677ac40f46644d1d5cfc2424a4

Example Responses

Status code: 200

Successful query

{
  "id" : "1131ed520xxxxxxebedb6e57xxxxxxxx",
  "ip_cidr" : "192.168.xx.xx/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 query

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Permissions Management