调用DescribeDirectories查询目录的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDirectories

系统规定参数。取值：DescribeDirectories。
RegionId String 是 cn-hangzhou

地域ID。
DirectoryType String 否 RAM

目录类型。取值范围：

  • RAM：RAM类型的目录。
  • AD_CONNECTOR：AD类型的目录。
DirectoryId.N RepeatList 否 cn-hangzhou+dir-gx2x1dhsmu52rd****

目录ID。可设置一个或多个。
MaxResults Integer 否 10

分页查询时每页行数。

最大值：100。

默认值：10。
NextToken String 否 caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token，NextToken为空表示没有下一个。

返回数据

名称 类型 示例值 描述
Directories Array of Directory

目录信息组成的集合。
ADConnectors Array of ADConnector

AD连接器的信息。
ADConnectorAddress String 172.17.**.**

连接地址。
ConnectorStatus String RUNNING

连接状态。可能值：

  • CREATING：创建中。
  • CONNECTING：连接中。需要用户在自有AD上配置域信任。
  • RUNNING：运行中。
  • EXPIRED：欠费过期。
  • CONNECT_ERROR：连接错误。
NetworkInterfaceId String eni-bp1i4wx78lgosrj6****

AD连接器挂载的网卡ID。
VSwitchId String vsw-bp19ocz3erfx15uon****

AD连接器所在的交换机ID。
CreationTime String 2020-11-02T01:44Z

目录创建时间。
CustomSecurityGroupId String sg-bp1ce64o4g9mdf5u****

安全组ID。
DesktopAccessType String Internet

连接云桌面时允许使用的方式。可能值：

  • Internet：公网连接
  • VPC：VPC连接
  • Any：公网和VPC均可
DesktopVpcEndpoint String http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com

VPC连接桌面时所使用的终端节点。
DirectoryId String cn-hangzhou+dir-gx2x1dhsmu52rd****

目录ID。
DirectoryType String RAM

目录类型。可能值：

  • RAM
  • AD_CONNECTOR
DnsAddress List ["171.17.**.**"]

目录的DNS地址。
DnsUserName String testDnsUserName

DNS用户名。
DomainName String example.com

域名称。
DomainPassword String testPassword

域管理员的用户密码。
DomainUserName String sAMAccountName

域管理员的用户名。
EnableInternetAccess Boolean false

是否可上网。

说明 该参数暂未开放使用。
Logs Array of Log

注册日志信息。
Level String INFO

日志级别。可能值：

  • INFO：信息
  • ERROR：错误
  • WARN：警告
Message String code:success | message:Create Connector complete.

日志详细信息。
Step String DescribeDirectories

日志对应的步骤。
TimeStamp String 2021-01-22T06:45Z

日志打印时间。
Name String testDirectoryName

目录名称。
Status String REGISTERING

AD类型的目录状态。可能值：

  • REGISTERING：注册中
  • REGISTERED：已注册
TrustPassword String 82Tg****

AD信任密码。
VSwitchIds List vsw-bp19ocz3erfx15uon****

目录创建时设置的交换机ID。
VpcId String vpc-uf6tz5k67puge5jn8****

交换机所属的VPC ID。
NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token，NextToken为空表示没有下一个。
RequestId String F369A091-002F-49C8-AD55-02A776297C7B

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeDirectories
&MaxResults=10
&DirectoryType=RAM
&<公共请求参数>

正常返回示例

XML格式 

<DescribeDirectoriesResponse>
      <Directories>
            <Status>REGISTERING</Status>
            <DomainName>example.com</DomainName>
            <CustomSecurityGroupId>sg-bp1ce64o4g9mdf5u****</CustomSecurityGroupId>
            <Name>testDirectoryName</Name>
            <DirectoryType>RAM</DirectoryType>
            <DomainPassword>testPassword</DomainPassword>
            <TrustPassword>82Tg****</TrustPassword>
            <DirectoryId>cn-hangzhou+dir-gx2x1dhsmu52rd****</DirectoryId>
            <DesktopVpcEndpoint>http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com</DesktopVpcEndpoint>
            <VpcId>vpc-uf6tz5k67puge5jn8****</VpcId>
            <CreationTime>2020-11-02T01:44Z</CreationTime>
            <DesktopAccessType>Internet</DesktopAccessType>
            <DomainUserName>sAMAccountName</DomainUserName>
            <EnableInternetAccess>false</EnableInternetAccess>
            <DnsUserName>testDnsUserName</DnsUserName>
      </Directories>
      <Directories>
            <ADConnectors>
                  <ADConnectorAddress>172.17.**.**</ADConnectorAddress>
                  <NetworkInterfaceId>eni-bp1i4wx78lgosrj6****</NetworkInterfaceId>
                  <ConnectorStatus>RUNNING</ConnectorStatus>
                  <VSwitchId>vsw-bp19ocz3erfx15uon****</VSwitchId>
            </ADConnectors>
            <Logs>
                  <Level>INFO</Level>
                  <Step>DescribeDirectories</Step>
                  <Message>code:success | message:Create Connector complete.</Message>
                  <TimeStamp>2021-01-22T06:45Z</TimeStamp>
            </Logs>
      </Directories>
      <Directories>
            <VSwitchIds>vsw-bp19ocz3erfx15uon****</VSwitchIds>
            <DnsAddress>["171.17.**.**"]</DnsAddress>
      </Directories>
      <RequestId>F369A091-002F-49C8-AD55-02A776297C7B</RequestId>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
</DescribeDirectoriesResponse>

JSON格式 

{
	"Directories": [{
		"Status": "REGISTERING",
		"DomainName": "example.com",
		"CustomSecurityGroupId": "sg-bp1ce64o4g9mdf5u****",
		"Name": "testDirectoryName",
		"DirectoryType": "RAM",
		"DomainPassword": "testPassword",
		"TrustPassword": "82Tg****",
		"DirectoryId": "cn-hangzhou+dir-gx2x1dhsmu52rd****",
		"DesktopVpcEndpoint": "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
		"VpcId": "vpc-uf6tz5k67puge5jn8****",
		"CreationTime": "2020-11-02T01:44Z",
		"DesktopAccessType": "Internet",
		"DomainUserName": "sAMAccountName",
		"EnableInternetAccess": "false",
		"DnsUserName": "testDnsUserName"
	}, {
		"ADConnectors": [{
			"ADConnectorAddress": "172.17.**.**",
			"NetworkInterfaceId": "eni-bp1i4wx78lgosrj6****",
			"ConnectorStatus": "RUNNING",
			"VSwitchId": "vsw-bp19ocz3erfx15uon****"
		}],
		"Logs": [{
			"Level": "INFO",
			"Step": "DescribeDirectories",
			"Message": "code:success | message:Create Connector complete.",
			"TimeStamp": "2021-01-22T06:45Z"
		}]
	}, {
		"VSwitchIds": "vsw-bp19ocz3erfx15uon****",
		"DnsAddress": "[\"171.17.**.**\"]"
	}],
	"RequestId": "F369A091-002F-49C8-AD55-02A776297C7B",
	"NextToken": "caeba0bbb2be03f84eb48b699f0a4883"
}

错误码

访问错误中心查看更多错误码。