首页 无影云桌面 API参考(云桌面管控) API目录 工作区 CreateADConnectorOfficeSite - 创建AD工作区

CreateADConnectorOfficeSite - 创建AD工作区

创建一个企业AD账号的工作区。

接口说明

  • 创建AD工作区时,系统将自动创建AD Connector来对接企业AD,您需要支付AD Connector的费用。更多信息,请参见计费概述

  • 调用本接口创建AD工作区后,您还需要完成AD域的相关配置。操作流程如下: 1.在DNS服务器中完成条件转发器。 2.在AD域服务器中完成信任关系配置,然后调用ConfigADConnectorTrust为AD工作区配置信任关系。 3.调用ListUserAdOrganizationUnits获取AD域的组织单元OU信息,然后调用ConfigADConnectorUser为AD工作区指定组织单元OU和管理员。

    说明创建AD工作区时,如果传入了域管理员和密码(DomainUserName和DomainPassword),则后续只需要配置条件转发器;如果未传入域管理员和密码,则后续需要按照流程完成条件转发器、信任关系和指定OU的配置,

更多信息,请参见创建AD工作

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

地域ID。

cn-hangzhou
CidrBlockstring

工作区对应的安全办公网络包含的IPv4网段。系统将根据输入的IPv4网段,自动创建一个专有网络VPC。建议您使用10.0.0.0/12,172.16.0.0/12,192.168.0.0/16及其子网作为IPv4网段。如果设置了10或者172网段,掩码有效范围为1224位,如果设置了192网段,掩码有效范围为1624位。

47.100.XX.XX
CenOwnerIdlong

云企业网实例所属的阿里云账号ID。

  • 如果未配置CenId,或者配置的CenId属于本阿里云账号,该参数无需配置。
  • 如果配置的CenId属于其它阿里云账号,请填写所属阿里云账号的ID。
102681951715****
CenIdstring

云企业网实例ID。

cen-3gwy16dojz1m65****
VerifyCodestring

验证码。如果配置的CenId属于其它阿里云账号,必须先调用SendVerifyCode获取验证码。

12****
Bandwidthinteger

公网带宽峰值。取值范围:0~200。
不设置该参数或者设置为0表示不开通互联网访问功能。

1
DomainNamestring

企业AD的域名。相同的域名只能注册一次。

example.com
DomainUserNamestring

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

说明用户名请使用sAMAccountName,不能使用userPrincipalName。
Administrator
DomainPasswordstring

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

testPassword
OfficeSiteNamestring

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

test
EnableAdminAccessboolean

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

true
DesktopAccessTypestring

连接云桌面时允许使用的方式。取值范围:

  • Internet:只允许客户端通过公网连接云桌面。
  • VPC:只允许处于VPC网络内的客户端连接云桌面。
  • Any:不限制方式。使用客户端连接云桌面时可以自行选择连接方式。

默认值:Internet。

说明VPC连接方式依赖于阿里云私网连接(PrivateLink)服务,该服务不收取费用。该参数设置为VPC或者Any时,系统将自动为您开通私网连接服务。
Internet
EnableInternetAccessboolean

是否开通公网访问功能。

true
SubDomainNamestring

企业AD子域的域名。

child.example.com
MfaEnabledboolean

是否开启多因素认证MFA。

false
DnsAddressarray

企业AD对应DNS的IP地址。目前仅支持设置一个。

string

企业AD对应DNS的IP地址。目前仅支持设置一个。

192.168.XX.XX
SubDomainDnsAddressarray

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

string

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

192.168.XX.XX
Specificationlong

AD Connector规格。

  • 1:通用型
  • 2:高级型
1
AdHostnamestring

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

beijing-ad01
ProtocolTypestring

协议类型。取值范围:ASP。

ASP

返回参数

名称类型描述示例值
object

返回对象。

RequestIdstring

请求ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OfficeSiteIdstring

工作区ID。

cn-hangzhou+dir-363353****

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "OfficeSiteId": "cn-hangzhou+dir-363353****"
}

错误码

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

变更历史

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