加入AD域
功能介绍
加入AD域。Active Directory域(简称:AD域)提供统一的身份认证和授权管理。通过将SFS Turbo文件系统的挂载点接入AD域内,您可以在AD域中实现文件系统用户身份的认证管理和文件级别的访问权限控制。
接口约束
该接口仅适用于SMB文件系统共享协议。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/active-directory-domain
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
share_id |
是 |
String |
文件系统ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
账号的token |
Content-Type |
是 |
String |
MIME类型 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
service_account |
是 |
String |
服务账号,在创建域服务器时指定,一般默认为administrator |
password |
是 |
String |
账号对应密码 |
domain_name |
是 |
String |
域控服务器的域名,在创建域服务器时指定 |
system_name |
是 |
String |
存储系统在AD域中的名称 |
overwrite_same_account |
否 |
Boolean |
如果域控制器中已存在同系统名称的存储系统,开启该选项后,将覆盖原有的存储系统信息。 |
dns_server |
是 |
Array of strings |
DNS服务器IP地址,用于解析AD域的域名 |
organization_unit |
否 |
String |
域中包含的一类目录对象如用户、计算机、打印机等资源的总称,加入后将作为其中的一员。若不填,则默认加入到computers组织单元。 |
vpc_id |
否 |
String |
vpc的id |
响应参数
状态码:202
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
加入AD域异步任务的id |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID |
参数 |
参数类型 |
描述 |
---|---|---|
errCode |
String |
错误码 |
errMsg |
String |
错误描述 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID |
参数 |
参数类型 |
描述 |
---|---|---|
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" }
响应示例
状态码: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 |
错误响应 |
错误码
请参见错误码。