Help Center> Scalable File Service> API Reference> SFS Turbo APIs> Permissions Management> Querying a Permission Rule of a File System
Updated on 2024-01-03 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. The value can be rw (read and write permission) or ro (read only permission). The default value is rw.

user_type

String

File system access permission granted to the user of the authorized object. The value can be no_root_squash, root_squash, or all_squash. Value no_root_squash allows the root user on the client to access the file system as root. Value root_squash allows the root user on the client to access the file system as nfsnobody. Value all_squash allows any user on the client to access the file system as nfsnobody. The default value is all_squash.

Status code: 400

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

Parameter

Type

Description

errCode

String

Error code

Minimum: 8

Maximum: 36

errMsg

String

Error description

Minimum: 2

Maximum: 512

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.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 query

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Permissions Management