首页 无影云桌面 API参考(云桌面管控) API目录 目录 CreateADConnectorDirectory - 创建AD类型的目录

CreateADConnectorDirectory - 创建AD类型的目录

调用CreateADConnectorDirectory创建AD类型的目录。

接口说明

AD目录用于对接企业自有AD,适合较大规模的桌面部署。对接企业AD需要支付目录费用,更多信息,请参见计费概述

调试

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

调试

授权信息

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

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

请求参数

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

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

cn-hangzhou
DomainNamestring

输入企业AD的全限定域名(FQDN),同时带有主机名和域名。相同的域名只能注册一次。

corp.example.com
DomainUserNamestring

域管理员的用户名。最长支持64个英文字符。

sAMAccountName
DomainPasswordstring

域管理员的用户密码。最长支持64个英文字符。

testPassword
DirectoryNamestring

目录名称。长度为2~255个英文或中文字符。必须以大小写字母或中文开头,不能以http://https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

testDirectoryName
EnableAdminAccessboolean

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

true
枚举值:
- true: 赋予本地管理员权限 [默认值]
- false: 不赋予本地管理员权限
DesktopAccessTypestring

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

Internet
枚举值:
- VPC: VPC连接
- Internet: 公网连接 [默认值]
- Any: 公网和VPC均可
SubDomainNamestring

企业已有AD子域的全限定域名(FQDN),同时带有主机名和域名。

child.example.com
MfaEnabledboolean

是否启用MFA认证。开启后,该目录下的所有AD用户登录云桌面时,输入正确密码后,还需输入MFA设备生成的动态验证码。

说明首次登录时,需绑定MFA设备。
false
枚举值:
- true: 启用MFA认证
- false: 不启用MFA认证 [默认值]
DnsAddressarray

企业AD对应DNS的IP地址。目前仅支持设置一个。请确保该IP地址在所选的交换机网络下可以访问。

string

企业AD对应DNS的IP地址。

127.0.**.**
VSwitchIdarray

交换机ID。目前仅支持设置一个。

string

交换机ID。

vsw-bp19ocz3erfx15uon****
SubDomainDnsAddressarray

企业已有AD子域的DNS地址。
如果设置了SubDomainName,而未设置此参数,则认为子域DNS和父域一致。

string

企业已有AD子域的DNS地址。

127.0.**.**
Specificationlong

AD Connector规格。

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

返回参数

名称类型描述示例值
object

返回信息集合。

TrustPasswordstring

AD信任密码。

82Tg****
RequestIdstring

请求ID。

3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF
DirectoryIdstring

AD类型的目录ID。

cn-hangzhou+dir-gx2x1dhsmu52rd****
AdConnectorsarray

AD Connector的信息集合。

object

AD Connector。

Addressstring

连接地址。

127.0.**.**

示例

正常返回示例

JSON格式

{
  "TrustPassword": "82Tg****",
  "RequestId": "3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF",
  "DirectoryId": "cn-hangzhou+dir-gx2x1dhsmu52rd****",
  "AdConnectors": [
    {
      "Address": "127.0.**.**"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-08-19OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Specification
阿里云首页 无影云桌面 相关技术圈