文档首页/ 高性能弹性文件服务 SFS Turbo/ API参考/ API/ 权限管理/ 加入AD域 - AddActiveDirectoryDomain
更新时间：2026-09-30 GMT+08:00
查看PDF
分享

加入AD域 - AddActiveDirectoryDomain

功能介绍

加入AD域。Active Directory域（简称：AD域）提供统一的身份认证和授权管理。通过将SFS Turbo文件系统的挂载点接入AD域内，您可以在AD域中实现文件系统用户身份的认证管理和文件级别的访问权限控制。

接口约束

该接口仅适用于SMB文件系统共享协议。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/active-directory-domain

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于标识资源所属的IAM项目空间，实现项目级资源隔离与权限管控。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

share_id

是

String

参数解释：

文件系统ID，用于唯一标识SFS Turbo文件系统实例。

获取方法请参见查询文件系统列表接口。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，用于鉴权认证。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

请求消息体MIME类型，用于标识请求正文的数据格式。

约束限制：

不涉及。

取值范围：

application/json

默认取值：

application/json
表3 请求Body参数

参数

是否必选

参数类型

描述

service_account

是

String

参数解释：

AD域服务账号，用于连接AD域控服务器的管理员账号，在创建域服务器时指定。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

administrator

password

是

String

参数解释：

AD域服务账号对应的密码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

domain_name

是

String

参数解释：

域控服务器的域名，在创建域服务器时指定。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

system_name

是

String

参数解释：

文件系统在AD域中的名称，用于在域中唯一标识文件系统。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

overwrite_same_account

否

Boolean

参数解释：

如果域控制器中已存在相同系统名称的文件系统，开启该选项后，将覆盖原有文件系统信息。

约束限制：

不涉及。

取值范围：

  • true：覆盖原有文件系统信息。

  • false：不覆盖原有文件系统信息。

默认取值：

false

dns_server

是

Array of strings

参数解释：

DNS服务器IP地址列表，用于解析AD域的域名。

约束限制：

至少配置1个、最多3个DNS服务器IP地址。第一个为主选DNS服务器，其余为备选。

取值范围：

不涉及。

默认取值：

不涉及。

organization_unit

否

String

参数解释：

组织单元（OU），域中包含的一类目录对象，如用户、计算机、打印机等资源，文件系统加入后将归属于该组织单元。

约束限制：

若不填，则默认加入到computers组织单元。

取值范围：

不涉及。

默认取值：

computers

vpc_id

否

String

参数解释：

文件系统所在的VPC ID，用于域控服务器与文件系统之间的网络通信。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：202

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释：

请求ID，用于唯一标识和追踪本次请求。

取值范围：

不涉及。
表5 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

加入AD域异步任务的ID，用于查询任务执行状态和结果。

取值范围：

不涉及。

状态码：400

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释：

请求ID，用于唯一标识和追踪本次请求。

取值范围：

不涉及。
表7 响应Body参数

参数

参数类型

描述

errCode

String

参数解释：

错误码，用于标识请求失败的原因。详细错误码请参见错误码。

取值范围：

不涉及。

errMsg

String

参数解释：

错误描述，用于描述请求失败的具体原因，便于排查问题。请参见错误码。

取值范围：

不涉及。

状态码：500

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释：

请求ID，用于唯一标识和追踪本次请求。

取值范围：

不涉及。
表9 响应Body参数

参数

参数类型

描述

errCode

String

参数解释：

错误码，用于标识请求失败的原因。详细错误码请参见错误码。

取值范围：

不涉及。

errMsg

String

参数解释：

错误描述，用于描述请求失败的具体原因，便于排查问题。请参见错误码。

取值范围：

不涉及。

请求示例

加入AD域

POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/{share_id}/fs/active-directory-domain

{
  "service_account" : "administrator",
  "password" : "pwdxxxxx",
  "domain_name" : "SFSTURBO.COM",
  "system_name" : "sfs",
  "dns_server" : [ "100.xxx:xxx" ]
}

响应示例

状态码：202

无

状态码：400

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "parameter domain_name is required and cannot be empty"
}

状态码：500

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

状态码

状态码

描述

202

加入AD域请求下发成功

400

错误响应

500

错误响应

错误码

请参见错误码。

父主题： 权限管理

相关文档