首页 无影云桌面 API参考(云桌面管控) API目录 目录 DescribeDirectories - 查询目录的详细信息

DescribeDirectories - 查询目录的详细信息

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:DescribeDirectoriesLIST
  • ECD
    acs:ecd:{#regionId}:{#accountId}:*

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。可以调用DescribeRegions获取无影云桌面支持的地域列表。

cn-hangzhou
DirectoryTypestring

目录类型。

RAM
枚举值:
- AD_CONNECTOR: AD类型的目录
- RAM: RAM类型的目录
DirectoryStatusstring

工作区状态,和Status相同。

REGISTERED
MaxResultsinteger

分页查询时每页行数。

最大值:100。

默认值:10。

10
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
DirectoryIdarray

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

string

目录ID。

cn-hangzhou+dir-gx2x1dhsmu52rd****
Statusstring

工作区状态。

REGISTERED
枚举值:
- REGISTERING: 注册中
- DEREGISTERING: 取消中
- REGISTERED: 已注册
- NEEDCONFIGTRUST: 需要配置信任关系
- CONFIGTRUSTFAILED: 配置信任关系失败
- DEREGISTERED: 已取消
- ERROR: 配置错误
- CONFIGTRUSTING: 配置信任关系中
- NEEDCONFIGUSER: 需要配置用户

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求ID。

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

目录信息组成的集合。

object

目录信息。

EnableInternetAccessboolean

是否可上网。

说明该参数暂未开放使用。
false
VpcIdstring

交换机所属的VPC ID。

vpc-uf6tz5k67puge5jn8****
CreationTimestring

目录创建时间。

2020-11-02T01:44Z
Statusstring

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

  • REGISTERING:注册中
  • REGISTERED:已注册
REGISTERING
DomainPasswordstring

域管理员的用户密码。

testPassword
EnableAdminAccessboolean

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

true
SubDomainNamestring

企业已有AD子域的全限定域名(FQDN),即同时带有主机名和域名,如:child.example.com。

child.example.com
DomainUserNamestring

域管理员的用户名。

sAMAccountName
EnableCrossDesktopAccessboolean

是否开通工作区内桌面互通功能。

开启工作区内桌面互通后,同一个工作区内的桌面之间可以实现相互访问彼此的网络。

true
CustomSecurityGroupIdstring

安全组ID。

sg-bp1ce64o4g9mdf5u****
DesktopVpcEndpointstring

VPC连接桌面时所使用的终端节点。

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

是否开启SSO认证。

false
DomainNamestring

域名称。

example.com
DesktopAccessTypestring

连接云桌面时允许使用的方式。

Internet
枚举值:
- VPC: VPC连接
- Internet: 公网连接
- Any: 公网和VPC均可
MfaEnabledboolean

是否开启多因素认证MFA。

false
DirectoryTypestring

目录类型。

RAM
枚举值:
- AD_CONNECTOR: AD_CONNECTOR
- RAM: RAM
DnsUserNamestring

DNS用户名。

testDnsUserName
TrustPasswordstring

AD信任密码。

82Tg****
OuNamestring

指定云桌面加域时选择的组织单元。

example.com/Domain Controllers
Namestring

目录名称。

testDirectoryName
DirectoryIdstring

目录ID。

cn-hangzhou+dir-gx2x1dhsmu52rd****
ADConnectorsarray

AD连接器的信息。

object

AD连接器的信息。

ConnectorStatusstring

连接状态。

RUNNING
枚举值:
- CONNECT_ERROR: 连接错误
- RUNNING: 运行中
- CONNECTING: 连接中。需要用户在自有AD上配置域信任。
- EXPIRED: 欠费过期
- CREATING: 创建中
VSwitchIdstring

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

vsw-bp19ocz3erfx15uon****
ADConnectorAddressstring

连接地址。

172.17.**.**
TrustKeystring

AD域控信任密码。

yfpoAD****
NetworkInterfaceIdstring

AD连接器挂载的网卡ID。

eni-bp1i4wx78lgosrj6****
Specificationstring

AD Connector规格。

1
枚举值:
- 1: 通用型
- 2: 高级型
Logsarray

注册日志信息。

object

注册日志信息。

Stepstring

日志对应的步骤。

DescribeDirectories
Messagestring

日志详细信息。

code:success | message:Create Connector complete.
TimeStampstring

日志打印时间。

2021-01-22T06:45Z
Levelstring

日志级别。

INFO
枚举值:
- ERROR: 错误
- INFO: 信息
- WARN: 警告
VSwitchIdsarray

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

string

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

vsw-bp19ocz3erfx15uon****
FileSystemIdsarray

NAS文件系统ID。

string

NAS文件系统ID。

05b534****
SubDnsAddressarray

AD子域的DNS地址。

string

AD子域的DNS地址。

172.24.XX.XX
DnsAddressarray

目录的DNS地址。

string

目录的DNS地址。

172.24.XX.XX
NeedVerifyLoginRiskboolean

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

false
AdHostnamestring

域控主机名。 必须符合Windows主机命名规范。

cnshsv21hmc****

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "F369A091-002F-49C8-AD55-02A776297C7B",
  "Directories": [
    {
      "EnableInternetAccess": true,
      "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": true,
      "DomainName": "example.com",
      "DesktopAccessType": "Internet",
      "MfaEnabled": true,
      "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": true
    }
  ],
  "AdHostname": "cnshsv21hmc****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-08-19OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-19OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 无影云桌面 相关技术圈