Querying the AD Domain Configuration

Function

This API is used to query the AD domain configuration. AD DS is a directory service that provides unified identity and permissions management through domain networks. By adding an SFS Turbo file system to an AD domain, you can easily authenticate and manage user identities and control file permissions in that domain.

Constraints

This API is only supported for SMB file systems.

URI

GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/active-directory-domain

**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
domain_name	String	The domain name of the domain controller. It is specified when the domain server is created.
system_name	String	The name of the file system in the AD domain.
dns_server	Array of strings	The IP address of the DNS server. It is used to resolve the AD domain name.
organization_unit	String	A group of domain objects, such as users, computers, and printers. If you add the file system to an OU, it will become a member of that OU. If this parameter is left blank, the file system will be added to the computers OU.
vpc_id	String	The VPC ID.
status	String	The current status of the AD domain. Enumeration values: JOINING AVAILABLE EXITING FAILED

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: 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

Previous topic: Joining an AD Domain

Next topic: Modifying the AD Domain Configuration

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot