All Products
Search

This Product

    WUYING Workspace:DescribeDirectories

    Document Center

    WUYING Workspace:DescribeDirectories

    Last Updated:Apr 17, 2024

    Queries the details of directories.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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:
      • The required resource types are displayed in bold characters.
      • 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    ecd:DescribeDirectoriesLIST
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    DirectoryTypestringNo

    The directory type.

    Valid values:

    • SIMPLE: a directory of the convenience account type
    • AD_CONNECTOR: an AD directory
    • RAM: a RAM directory
    		RAM
    DirectoryStatusstringNo

    The directory status. This parameter is equivalent to Status.

    		REGISTERED
    MaxResultsintegerNo

    The number of entries to return on each page.

    Maximum value: 100.

    Default value: 10.

    		10
    NextTokenstringNo

    The token that determines the start point of the next query. If this parameter is empty, all results are returned.

    		caeba0bbb2be03f84eb48b699f0a4883
    DirectoryIdarrayNo

    Details of directory IDs. You can specify one or more directory IDs.

    stringNo

    The ID of the directory.

    		cn-hangzhou+dir-gx2x1dhsmu52rd****
    StatusstringNo

    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

    ParameterTypeDescriptionExample
    object

    The response parameters.

    NextTokenstring

    The token that is used for the next query. If this parameter is empty, all results are returned.

    		caeba0bbb2be03f84eb48b699f0a4883
    RequestIdstring

    The ID of the request.

    		F369A091-002F-49C8-AD55-02A776297C7B
    Directoriesobject []

    The directories.

    EnableInternetAccessboolean

    Indicates whether access over the Internet is enabled.

    Note This parameter is unavailable.
    		false
    VpcIdstring

    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****
    CreationTimestring

    The time when the directory was created.

    		2020-11-02T01:44Z
    Statusstring

    The status of the AD directory.

    Valid values:

    • REGISTERING

    • REGISTERED

    		REGISTERING
    DomainPasswordstring

    The password of the domain administrator. This parameter is returned only when the directory type is AD office network.

    		testPassword
    EnableAdminAccessboolean

    Indicates whether the local administrator permissions are granted to users that use cloud computers in the office network.

    		true
    SubDomainNamestring

    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
    DomainUserNamestring

    The username of the domain administrator.

    		sAMAccountName
    EnableCrossDesktopAccessboolean

    Indicates whether cloud computers can communicate with each other in the directory.

    		true
    CustomSecurityGroupIdstring

    The security group ID. This parameter is returned only when the directory type is AD office network.

    		sg-bp1ce64o4g9mdf5u****
    DesktopVpcEndpointstring

    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
    SsoEnabledboolean

    Indicates whether single sign-on (SSO) is enabled.

    		false
    DomainNamestring

    The domain name.

    		example.com
    DesktopAccessTypestring

    The method in which the cloud computer is connected.

    Valid values:

    • VPC

    • Internet

    • Any

    		Internet
    MfaEnabledboolean

    Indicates whether MFA is enabled.

    		false
    DirectoryTypestring

    The directory type.

    Valid values:

    • AD_CONNECTOR: AD directory

    • RAM: RAM directory

    		RAM
    DnsUserNamestring

    The username of a DNS user.

    		testDnsUserName
    TrustPasswordstring

    The AD trust password. This parameter is returned only when the directory type is AD office network.

    		82Tg****
    OuNamestring

    The organization unit that you selected when you added the cloud computer to the domain.

    		example.com/Domain Controllers
    Namestring

    The directory name.

    		testDirectoryName
    DirectoryIdstring

    The directory ID.

    		cn-hangzhou+dir-gx2x1dhsmu52rd****
    ADConnectorsobject []

    Details of the AD connector.

    ConnectorStatusstring

    Valid values:

    • CONNECT_ERROR
    • RUNNING
    • CONNECTING: You must configure domain trust for your AD system.
    • EXPIRED
    • CREATING
    		RUNNING
    VSwitchIdstring

    The ID of the vSwitch with which the AD connector is associated.

    		vsw-bp19ocz3erfx15uon****
    ADConnectorAddressstring

    The connection address.

    		172.17.**.**
    TrustKeystring

    The trust password of the AD domain controller.

    		yfpoAD****
    NetworkInterfaceIdstring

    The ID of the NIC to which the AD connector is mounted.

    		eni-bp1i4wx78lgosrj6****
    Specificationstring

    The AD connector type.

    Valid values:

    • 1: General

    • 2: Advanced

    		1
    Logsobject []

    The registration logs. This parameter is returned only when the directory type is AD office network.

    Stepstring

    The step that corresponds to the log entry.

    		DescribeDirectories
    Messagestring

    Details of the log entry.

    		code:success | message:Create Connector complete.
    TimeStampstring

    The time when the log entry was printed.

    		2021-01-22T06:45Z
    Levelstring

    The level of the log entry.

    Valid values:

    • ERROR

    • INFO

    • WARN

    		INFO
    VSwitchIdsarray

    The IDs of the vSwitches specified when the directory was created.

    string

    The IDs of the vSwitches specified when the directory was created.

    		vsw-bp19ocz3erfx15uon****
    FileSystemIdsarray

    The IDs of Apsara File Storage NAS (NAS) file systems.

    string

    The IDs of Apsara File Storage NAS (NAS) file systems.

    		05b534****
    SubDnsAddressarray

    The DNS address of the enterprise AD subdomain.

    string

    The DNS address of the enterprise AD subdomain.

    		172.24.XX.XX
    DnsAddressarray

    The DNS address of the directory.

    string

    The DNS address of the directory.

    		172.24.XX.XX
    NeedVerifyLoginRiskboolean

    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
    AdHostnamestring

    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": "cnshsv21hmc****"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2021-08-19The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.
    2021-08-19The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.