Help Center/ Scalable File Service/ API Reference/ SFS Turbo APIs/ Permissions Management/ Querying the LDAP Configuration
Updated on 2025-07-22 GMT+08:00
View PDF
Share

Querying the LDAP Configuration

Function

This API is used to query the LDAP configuration.

Constraints

This API is only supported for NFS file systems.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

share_id

Yes

String

The file system 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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

url

String

The URL of the LDAP server.

base_dn

String

The base DN.

user_dn

String

The bind DN.

filter_condition

String

The search filters. This is a reserved field and is not supported currently.

vpc_id

String

The ID of the VPC that the specified LDAP server can connect to. This is a reserved field and is not supported currently.

backup_url

String

The URL of the standby LDAP server.

schema

String

The LDAP schema. If not specified, RFC2307 will be used.

search_timeout

Integer

The LDAP search timeout interval, in seconds. If not specified, 3 seconds will be used.

Status code: 500

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 5 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

None

Example Responses

Status code: 200

Successful query

  • Querying the LDAP configuration

    {
  "url" : "ldap://192.168.xx.xx:60000",
  "base_dn" : "dc=example,dc=com",
  "user_dn" : "cn=admin,dc=example,dc=com",
  "vpc_id" : "15e1a488-0ee5-4742-8fb7-168100000000",
  "backup_url" : "ldap://192.168.xx.xx:60000",
  "schema" : "RFC2307",
  "search_timeout" : 20
}

Status code: 500

Error response

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

Status Codes

Status Code

Description

200

Successful query

500

Error response

Error Codes

See Error Codes.

Parent topic: Permissions Management