文档

CreateADConnectorOfficeSite - 创建基于企业AD账号的办公网络

无影云电脑支持便捷账号和企业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。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
CidrBlockstring

办公网络 VPC 包含的 IPv4 网段。系统将根据输入的 IPv4 网段,自动创建一个专有网络 VPC。建议您使用以下网段及其子网作为 IPv4 网段:

  • 10.0.0.0/12(掩码有效范围为 12~24 位)
  • 172.16.0.0/12(掩码有效范围为 12~24 位)
  • 192.168.0.0/16(掩码有效范围为 16~24 位)
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赋予本地管理员权限 [默认值]
  • false不赋予本地管理员权限
true
DesktopAccessTypestring

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

说明 VPC 连接方式依赖于阿里云私网连接 PrivateLink 服务,该服务不收取费用。该参数设置为VPC或者Any时,系统将自动为您开通私网连接服务。
枚举值:
  • VPC只允许处于VPC网络内的客户端连接云电脑。
  • Internet只允许客户端通过公网连接云电脑。[默认值]
  • 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

协议类型。

枚举值:
  • ASPASP协议
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
  • 本页导读 (0)