查询目录的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:DescribeDirectories | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
| DirectoryType | string | 否 | 目录类型。 枚举值：
| SIMPLE |
| DirectoryStatus | string | 否 | 目录状态，和 | REGISTERED |
| MaxResults | integer | 否 | 分页查询时每页行数。 最大值：100。 默认值：10。 | 10 |
| NextToken | string | 否 | 下一个查询开始的 Token，NextToken 为空表示没有下一个。 | caeba0bbb2be03f84eb48b699f0a4883 |
| DirectoryId | array | 否 | 目录 ID。可设置一个或多个。 | |
| string | 否 | 目录 ID。 | cn-hangzhou+dir-gx2x1dhsmu52rd**** | |
| Status | string | 否 | 目录状态。 枚举值：
| REGISTERED |
返回参数
示例
正常返回示例
JSON格式
{
"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.XX.XX",
"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****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-06-26 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-08-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-08-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |