All Products
Search
Document Center

Elastic Desktop Service:DescribeDirectories

Last Updated:Oct 30, 2025

Queries directory details.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClientIdstringYes

The client ID. The system generates a unique ID for each client.

54c17e1d-2d72-4b87-aa33-25f3b3f2****
DirectoryIdarrayNo

The directory IDs.

stringNo

The directory ID, which is the same as the office network ID.

cn-hangzhou+dir-gx2x1dhsmu52rd****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

F369A091-002F-49C8-AD55-02A77629****
Directoriesarray<object>

The directories.

Directoryobject

The directory.

DirectoryTypestring

The directory type.

AD_CONNECTOR
SsoServiceUrlstring

The URL of the SSO service.

https://eds-cn-shanghai-67726****
DesktopAccessTypestring

The connection method.

Valid values:

  • VPC: End users connect to cloud computers over an enterprise virtual private cloud (VPC).
  • INTERNET: End users connect to cloud computers over the Internet.
  • ANY: End users connect to cloud computers over the Internet or an enterprise VPC.
INTERNET
DirectoryIdstring

The directory ID.

cn-hangzhou+dir-gx2x1dhsmu52rd****
ProviderIdstring

The provider ID.

26842

Examples

Sample success responses

JSONformat

{
  "RequestId": "F369A091-002F-49C8-AD55-02A77629****",
  "Directories": [
    {
      "DirectoryType": "AD_CONNECTOR",
      "SsoServiceUrl": "https://eds-cn-shanghai-67726****",
      "DesktopAccessType": "INTERNET",
      "DirectoryId": "cn-hangzhou+dir-gx2x1dhsmu52rd****",
      "ProviderId": 26842
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.