Help Center/ Scalable File Service/ API Reference/ SFS Turbo APIs/ Directory Management/ Checking Whether a Directory Exists
Updated on 2024-11-13 GMT+08:00
View PDF
Share

Checking Whether a Directory Exists

Function

This API is used to query whether a directory exists.

URI

GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/dir

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

share_id

Yes

String

File system ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

path

Yes

String

Full path of the directory to be queried

Request Parameters

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

Parameter

Type

Description

path

String

Full path of the directory

mode

Long

Permissions of the directory. This field is returned only for 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, and 20 MB/s/TiB file systems. The third digit indicates the permissions of the directory owner, the fourth digit indicates the permissions of the user group to which the directory belongs, and the fifth digit indicates the permissions of other users. The directory owner is specified by UID, and the user group to which the directory belongs is specified by GID. Users who are not the directory owner and not in the user group to which the directory belongs are other users. For example, in 40755, the third digit 7 indicates that the directory owner has the read, write, and execute permissions on the directory, the fourth digit 5 indicates that the user group to which the directory belongs has the read and execute permissions on the directory, and the fifth digit 5 indicates that other users have the read and execute permissions on the directory.

uid

Long

ID of the user who owns the directory. This field is returned only for 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, and 20 MB/s/TiB file systems.

gid

Long

ID of the user group to which the directory belongs. This field is returned only for 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, and 20 MB/s/TiB file systems.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Error code

errMsg

String

Error description

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Error code

errMsg

String

Error description

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

errCode

String

Error code

errMsg

String

Error description

Example Requests

Querying whether the directory /date/test can be found in the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde

GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/{share_id}/fs/dir?path=/date/test

Example Responses

Status code: 200

Query results

{
  "path" : "/date/test"
}

Status code: 400

Error response

{
  "errCode" : "SFS.TURBO.0100",
  "errMsg" : "invalid path"
}

Status code: 404

Directory not found

{
  "errCode" : "SFS.TURBO.0101",
  "errMsg" : "path not exist"
}

Status code: 500

Error response

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

Status Codes

Status Code

Description

200

Query results

400

Error response

404

Directory not found

500

Error response

Error Codes

See Error Codes.

Parent topic: Directory Management