查询AD域配置 - ShowActiveDirectoryDomain
功能介绍
查询AD域配置。Active Directory域(简称:AD域)提供统一的身份认证和授权管理。通过将SFS Turbo文件系统的挂载点接入AD域内,您可以在AD域中实现文件系统用户身份的认证管理和文件级别的访问权限控制。
接口约束
该接口仅适用于SMB文件系统共享协议。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/active-directory-domain
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| share_id | 是 | String | 参数解释: 文件系统ID,用于唯一标识SFS Turbo文件系统实例。 获取方法请参见查询文件系统列表接口。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| domain_name | String | 参数解释: 域控服务器的域名,在创建域服务器时指定。 取值范围: 不涉及。 |
| system_name | String | 参数解释: 文件系统在AD域中的名称,用于在域中唯一标识文件系统。 取值范围: 不涉及。 |
| dns_server | Array of strings | 参数解释: DNS服务器IP地址列表,用于解析AD域的域名。 取值范围: 不涉及。 |
| organization_unit | String | 参数解释: 组织单元(OU),域中包含的一类目录对象,如用户、计算机、打印机等资源,文件系统加入后将归属于该组织单元。 取值范围: 不涉及。 |
| vpc_id | String | 参数解释: 文件系统所在的VPC ID,用于域控服务器与文件系统之间的网络通信。 取值范围: 不涉及。 |
| status | String | 参数解释: AD域当前状态,用于标识文件系统接入AD域的执行进度和结果。 取值范围: |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
请求示例
查询指定文件系统的AD域配置信息。
GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/{share_id}/fs/active-directory-domain 响应示例
状态码:200
{
"domain_name" : "SFSTURBO.COM",
"system_name" : "sfs",
"dns_server" : [ "192.168.xx.xx" ],
"organization_unit" : "computers",
"status" : "AVAILABLE"
} 状态码:500
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 500 | 错误响应 |
错误码
请参见错误码。