全部产品
Search

搜索本产品

    无影云电脑：CreateADConnectorDirectory - 创建AD类型的目录

    文档中心

    无影云电脑：CreateADConnectorDirectory - 创建AD类型的目录

    更新时间：Apr 03, 2024

    创建AD类型的目录。

    接口说明

    AD 目录用于对接企业自有 AD（Active Directory），适合较大规模的云电脑部署。对接企业 AD 需要支付目录费用，详细信息请参见计费概述。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    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：赋予本地管理员权限 [默认值]。
    • false：不赋予本地管理员权限。
    		true
    DesktopAccessTypestring否

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

    枚举值：
    • VPC：VPC连接。
    • Internet：公网连接 [默认值]。
    • Any：公网和VPC均可。
    		Internet
    SubDomainNamestring否

    企业已有 AD 子域的全限定域名（FQDN），同时带有主机名和域名。

    		child.example.com
    MfaEnabledboolean否

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

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

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

    string是

    企业 AD 对应 DNS 的 IP 地址。

    		127.0.XX.XX
    VSwitchIdarray是

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

    string是

    交换机 ID。

    		vsw-bp19ocz3erfx15uon****
    SubDomainDnsAddressarray否

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

    string否

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

    		127.0.XX.XX
    Specificationlong否

    AD Connector 规格。

    枚举值：
    • 1：通用型。
    • 2：高级型。
    		1

    返回参数

    名称类型描述示例值
    object

    返回信息集合。

    TrustPasswordstring

    AD 信任密码。

    		82Tg****
    RequestIdstring

    请求 ID。

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

    AD 类型的目录 ID。

    		cn-hangzhou+dir-gx2x1dhsmu52rd****
    AdConnectorsobject []

    AD Connector 的信息集合。

    Addressstring

    连接地址。

    		127.0.XX.XX

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2022-11-14API 内部配置变更，不影响调用看变更集
    变更项变更内容
    API 内部配置变更，不影响调用。
    2021-08-19OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更。
      新增入参：Specification