DescribeDirectories - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the details of directories.

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:DescribeDirectories	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DirectoryType	string	No	The directory type. Valid value: SIMPLE: the convenience directory. AD_CONNECTOR: the Active Directory (AD) directory.	RAM
DirectoryStatus	string	No	The directory status. This parameter is equivalent to `Status`.	REGISTERED
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
NextToken	string	No	The token that determines the start point of the next query. If this parameter is empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
DirectoryId	array	No	Details of directory IDs. You can specify one or more directory IDs.
	string	No	The ID of the directory.	cn-hangzhou+dir-gx2x1dhsmu52rd****
Status	string	No	The directory status. Valid values: REGISTERING: The directory is being registered. DEREGISTERING: The directory is being deregistered. REGISTERED: The directory is registered. NEEDCONFIGTRUST: A trust relationship needs to be configured for the directory. CONFIGTRUSTFAILED: A trust relationship fails to be configured for the directory. DEREGISTERED: The directory is deregistered. ERROR: One or more configurations of the directory are invalid. CONFIGTRUSTING: A trust relationship is being configured. NEEDCONFIGUSER: Users need to be configured for the directory.	REGISTERED

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that is used for the next query. If this parameter is empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	F369A091-002F-49C8-AD55-02A776297C7B
Directories	array<object>	The directories.
Directory	object	Details of the directory.
EnableInternetAccess	boolean	Indicates whether access over the Internet is enabled. Note This parameter is unavailable.	false
VpcId	string	The ID of the VPC to which the vSwitch belongs. This parameter is returned only when the directory type is AD office network.	vpc-uf6tz5k67puge5jn8****
CreationTime	string	The time when the directory was created.	2020-11-02T01:44Z
Status	string	The status of the AD directory. Valid values: REGISTERING REGISTERED	REGISTERING
DomainPassword	string	The password of the domain administrator. This parameter is returned only when the directory type is AD office network.	testPassword
EnableAdminAccess	boolean	Indicates whether the local administrator permissions are granted to users that use cloud computers in the office network.	true
SubDomainName	string	The fully qualified domain name (FQDN) of the existing AD subdomain. The value contains both the host name and the domain name.	child.example.com
DomainUserName	string	The username of the domain administrator.	sAMAccountName
EnableCrossDesktopAccess	boolean	Indicates whether cloud computers can communicate with each other in the directory.	true
CustomSecurityGroupId	string	The security group ID. This parameter is returned only when the directory type is AD office network.	sg-bp1ce64o4g9mdf5u****
DesktopVpcEndpoint	string	The endpoint that is used to connect to cloud computers in the directory over a VPC.	http://ep-bp1s2vmbj55r5rzc**.epsrv-bp1pcfhpwvlpny01**.cn-hangzhou.privatelink.aliyuncs.com
SsoEnabled	boolean	Indicates whether single sign-on (SSO) is enabled.	false
DomainName	string	The domain name.	example.com
DesktopAccessType	string	The method in which the cloud computer is connected. Valid values: VPC Internet Any	Internet
MfaEnabled	boolean	Indicates whether MFA is enabled.	false
DirectoryType	string	The directory type. Valid values: AD_CONNECTOR: AD directory RAM: RAM directory	RAM
DnsUserName	string	The username of a DNS user.	testDnsUserName
TrustPassword	string	The AD trust password. This parameter is returned only when the directory type is AD office network.	82Tg****
OuName	string	The organization unit that you selected when you added the cloud computer to the domain.	example.com/Domain Controllers
Name	string	The directory name.	testDirectoryName
DirectoryId	string	The directory ID.	cn-hangzhou+dir-gx2x1dhsmu52rd****
ADConnectors	array<object>	Details of the AD connector.
ADConnector	object	Details of the AD connector.
ConnectorStatus	string	Valid values: CONNECT_ERROR RUNNING CONNECTING: You must configure domain trust for your AD system. EXPIRED CREATING	RUNNING
VSwitchId	string	The ID of the vSwitch with which the AD connector is associated.	vsw-bp19ocz3erfx15uon****
ADConnectorAddress	string	The connection address.	172.17..
TrustKey	string	The trust password of the AD domain controller.	yfpoAD****
NetworkInterfaceId	string	The ID of the NIC to which the AD connector is mounted.	eni-bp1i4wx78lgosrj6****
Specification	string	The AD connector type. Valid values: 1: General 2: Advanced	1
Logs	array<object>	The registration logs. This parameter is returned only when the directory type is AD office network.
Log	object	Details of the registration log.
Step	string	The step that corresponds to the log entry.	DescribeDirectories
Message	string	Details of the log entry.	code:success \| message:Create Connector complete.
TimeStamp	string	The time when the log entry was printed.	2021-01-22T06:45Z
Level	string	The level of the log entry. Valid values: ERROR INFO WARN	INFO
VSwitchIds	array	The IDs of the vSwitches specified when the directory was created.
vSwitchId	string	The IDs of the vSwitches specified when the directory was created.	vsw-bp19ocz3erfx15uon****
FileSystemIds	array	The IDs of File Storage NAS (NAS) file systems.
FileSystemId	string	The IDs of File Storage NAS (NAS) file systems.	05b534****
SubDnsAddress	array	The DNS address of the enterprise AD subdomain.
SubAddress	string	The DNS address of the enterprise AD subdomain.	172.24.XX.XX
DnsAddress	array	The DNS address of the directory.
Address	string	The DNS address of the directory.	172.24.XX.XX
NeedVerifyLoginRisk	boolean	Indicates whether two-step verification for logons is enabled. This parameter is returned only for directories of convenience account type. If two-factor verification is enabled, the system checks whether security risks exist within the logon account when a convenience user logs on to an Alibaba Cloud Workspace client. If risks are detected, the system sends a verification code to the email address that is associated with the account. Then, the convenience user can log on to the client only after the user enters the correct verification code.	false
AdHostname	string	The hostname of the domain controller.	dc001
BackupDns	string	The DNS address of the backup domain controller.	192.168.2.100
BackupDCHostname	string	The hostname of the backup domain controller.	dc002
AdHostname	string	The hostname of the domain controller. The hostname must comply with the hostname naming convention of Windows. This parameter is returned only when the directory type is AD office network.	cnshsv21hmc****

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "F369A091-002F-49C8-AD55-02A776297C7B",
  "Directories": [
    {
      "EnableInternetAccess": false,
      "VpcId": "vpc-uf6tz5k67puge5jn8****",
      "CreationTime": "2020-11-02T01:44Z",
      "Status": "REGISTERING",
      "DomainPassword": "testPassword",
      "EnableAdminAccess": true,
      "SubDomainName": "child.example.com",
      "DomainUserName": "sAMAccountName",
      "EnableCrossDesktopAccess": true,
      "CustomSecurityGroupId": "sg-bp1ce64o4g9mdf5u****",
      "DesktopVpcEndpoint": "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
      "SsoEnabled": false,
      "DomainName": "example.com",
      "DesktopAccessType": "Internet",
      "MfaEnabled": false,
      "DirectoryType": "RAM",
      "DnsUserName": "testDnsUserName",
      "TrustPassword": "82Tg****",
      "OuName": "example.com/Domain Controllers",
      "Name": "testDirectoryName",
      "DirectoryId": "cn-hangzhou+dir-gx2x1dhsmu52rd****",
      "ADConnectors": [
        {
          "ConnectorStatus": "RUNNING",
          "VSwitchId": "vsw-bp19ocz3erfx15uon****",
          "ADConnectorAddress": "172.17.**.**",
          "TrustKey": "yfpoAD****",
          "NetworkInterfaceId": "eni-bp1i4wx78lgosrj6****",
          "Specification": 1
        }
      ],
      "Logs": [
        {
          "Step": "DescribeDirectories",
          "Message": "code:success | message:Create Connector complete.",
          "TimeStamp": "2021-01-22T06:45Z",
          "Level": "INFO"
        }
      ],
      "VSwitchIds": [
        "vsw-bp19ocz3erfx15uon****"
      ],
      "FileSystemIds": [
        "05b534****"
      ],
      "SubDnsAddress": [
        "172.24.XX.XX"
      ],
      "DnsAddress": [
        "172.24.XX.XX"
      ],
      "NeedVerifyLoginRisk": false,
      "AdHostname": "dc001",
      "BackupDns": "192.168.2.100",
      "BackupDCHostname": "dc002"
    }
  ],
  "AdHostname": "cnshsv21hmc****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-06-26	The response structure of the API has changed	View Change Details
2021-08-19	The response structure of the API has changed	View Change Details
2021-08-19	The response structure of the API has changed	View Change Details