AI 助理
文档备案控制台
官方文档
首页

DescribeDirectories - 查询目录的详细信息

更新时间：
复制 MD 格式
产品详情
我的收藏

查询目录的详细信息。

调试

您可以在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 :

    便捷账号类型的目录

  • AD_CONNECTOR :

    AD 类型的目录

SIMPLE
DirectoryStatus

string

否

目录状态，和Status相同。

REGISTERED
MaxResults

integer

否

分页查询时每页行数。

最大值：100。

默认值：10。

10
NextToken

string

否

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

caeba0bbb2be03f84eb48b699f0a4883
DirectoryId

array

否

目录 ID。可设置一个或多个。

cn-hangzhou+dir-gx2x1dhsmu52rd****

string

否

目录 ID。

cn-hangzhou+dir-gx2x1dhsmu52rd****
Status

string

否

目录状态。

枚举值：

  • REGISTERING :

    注册中

  • DEREGISTERING :

    取消中

  • REGISTERED :

    已注册

  • NEEDCONFIGTRUST :

    需要配置信任关系

  • CONFIGTRUSTFAILED :

    配置信任关系失败

  • DEREGISTERED :

    已取消

  • ERROR :

    配置错误

  • CONFIGTRUSTING :

    配置信任关系中

  • NEEDCONFIGUSER :

    需要配置用户

REGISTERED

返回参数

名称

类型

描述

示例值

object

返回信息集合。

NextToken

string

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

caeba0bbb2be03f84eb48b699f0a4883
RequestId

string

请求 ID。

F369A091-002F-49C8-AD55-02A776297C7B
Directories

array<object>

目录信息列表。

array<object>

目录信息。

EnableInternetAccess

boolean

是否可上网。

说明

该参数暂未开放使用。

false
VpcId

string

交换机所属的 VPC ID。仅当目录类型为 AD 办公网络时返回该参数。

vpc-uf6tz5k67puge5jn8****
CreationTime

string

目录创建时间。时间格式为 ISO 8601 标准（UTC 时间）。

2020-11-02T01:44Z
Status

string

AD 类型的目录状态。

枚举值：

  • REGISTERING :

    注册中

  • REGISTERED :

    已注册

REGISTERING
DomainPassword

string

域管理员的用户密码。仅当目录类型为 AD 办公网络时返回该参数。

testPassword
EnableAdminAccess

boolean

是否为使用云电脑的用户赋予本地管理员权限。

true
SubDomainName

string

企业已有 AD 子域的全限定域名（FQDN），即同时带有主机名和域名。

child.example.com
DomainUserName

string

域管理员的用户名。

sAMAccountName
EnableCrossDesktopAccess

boolean

是否开通目录内云电脑互通功能。开启后，同一个目录内的云电脑之间可以实现相互访问彼此的网络。

true
CustomSecurityGroupId

string

安全组 ID。仅当目录类型为 AD 办公网络时返回该参数。

sg-bp1ce64o4g9mdf5u****
DesktopVpcEndpoint

string

VPC 连接云电脑时所使用的终端节点。

http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com
SsoEnabled

boolean

是否开启 SSO 认证。

false
DomainName

string

域名称。

example.com
DesktopAccessType

string

连接云电脑时允许使用的方式。

枚举值：

  • VPC :

    VPC 连接

  • Internet :

    公网连接

  • Any :

    公网和 VPC 均可

Internet
MfaEnabled

boolean

是否开启多因素认证 MFA。

false
DirectoryType

string

目录类型。

枚举值：

  • AD_CONNECTOR :

    AD 类型的目录

  • RAM :

    RAM 类型的目录

RAM
DnsUserName

string

DNS 用户名。

testDnsUserName
TrustPassword

string

AD 信任密码。仅当目录类型为 AD 办公网络时返回该参数。

82Tg****
OuName

string

指定云电脑加域时选择的组织单元。

example.com/Domain Controllers
Name

string

目录名称。

testDirectoryName
DirectoryId

string

目录 ID。

cn-hangzhou+dir-gx2x1dhsmu52rd****
ADConnectors

array<object>

AD 连接器的信息。

object

AD 连接器的信息。

ConnectorStatus

string

连接状态。

枚举值：

  • CONNECT_ERROR :

    连接错误

  • RUNNING :

    运行中

  • CONNECTING :

    连接中。需要用户在自有 AD 上配置域信任

  • EXPIRED :

    欠费过期

  • CREATING :

    创建中

RUNNING
VSwitchId

string

AD 连接器所在的交换机 ID。

vsw-bp19ocz3erfx15uon****
ADConnectorAddress

string

连接地址。

172.17.XX.XX
TrustKey

string

AD 域控信任密码。

yfpoAD****
NetworkInterfaceId

string

AD 连接器挂载的网卡 ID。

eni-bp1i4wx78lgosrj6****
Specification

string

AD Connector 规格。

枚举值：

  • 1 :

    通用型

  • 2 :

    高级型

1
Logs

array<object>

注册日志信息列表。仅当目录类型为 AD 办公网络时返回该参数。

object

注册日志信息。

Step

string

日志对应的步骤。

DescribeDirectories
Message

string

日志详细信息。

code:success | message:Create Connector complete.
TimeStamp

string

日志打印时间。时间格式为 ISO 8601 标准（UTC 时间）。

2021-01-22T06:45Z
Level

string

日志级别。

枚举值：

  • ERROR :

    错误

  • INFO :

    信息

  • WARN :

    警告

INFO
VSwitchIds

array

目录创建时设置的交换机 ID。

string

目录创建时设置的交换机 ID。

vsw-bp19ocz3erfx15uon****
FileSystemIds

array

NAS 文件系统 ID。

string

NAS 文件系统 ID。

05b534****
SubDnsAddress

array

AD 子域的 DNS 地址。

string

AD 子域的 DNS 地址。

172.24.XX.XX
DnsAddress

array

目录的 DNS 地址。

string

目录的 DNS 地址。

172.24.XX.XX
NeedVerifyLoginRisk

boolean

登录是否需要二次验证。仅适用于便捷目录。
如果开启了登录二次验证，则便捷用户登录客户端时，系统将检测登录账号是否有安全风险。如果有风险，系统将发送验证码到该账号关联的邮箱，便捷用户使用验证码验证通过后才能登录客户端。

false
AdHostname

string

域控主机名。

dc001
BackupDns

string

备用域控 DNS 地址。

192.168.2.100
BackupDCHostname

string

备用域控主机名。

dc002
AdHostname

string

域控主机名。必须符合 Windows 主机命名规范。仅当目录类型为 AD 办公网络时返回该参数。

cnshsv21hmc****

示例

正常返回示例

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

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：CreateRAMDirectory - 创建RAM类型的目录下一篇：ListDirectoryUsers - 查询AD目录对应的用户信息