AI 助理
备案控制台
文档
输入文档关键字查找
首页 无影云电脑企业版 开发参考 API参考（云电脑管控） API目录 办公网络（原工作区） 基于企业AD账号的办公网络 CreateADConnectorOfficeSite - 创建基于企业AD账号的办公网络

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对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

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

请求参数

名称类型必填描述示例值
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否

协议类型。

枚举值：
  • ASP：ASP协议。
ASP
BackupDnsstring否

备用域控 DNS 地址。

192.168.2.100
BackupDCHostnamestring否

备用域控主机名。

dc002

返回参数

名称类型描述示例值
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****"
}

错误码

HTTP status code错误码错误信息描述
400NetworkSpace.VpcInfoExistvpc info already exist.对应VPC已存在办公网络

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

变更历史

变更时间变更内容概要操作
2024-06-26OpenAPI 入参发生变更查看变更详情
2021-10-28OpenAPI 入参发生变更查看变更详情
2021-10-28OpenAPI 入参发生变更查看变更详情
2021-08-19OpenAPI 入参发生变更查看变更详情
上一篇：基于企业AD账号的办公网络下一篇：ListUserAdOrganizationUnits - 获取AD域的组织单元
文档推荐