修改LDAP配置 - UpdateLdapConfig
功能介绍
修改LDAP配置。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
PUT /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/ldap
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| url | 否 | String | 参数解释: LDAP服务器的URL,固定格式为ldap://{ip_address}:{port_number}或ldaps://{ip_address}:{port_number},例如:ldap://192.168.0.1:60000。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| base_dn | 否 | String | 参数解释: LDAP服务器的Base DN(基础可分辨名称),即LDAP目录树中执行搜索操作的起始节点,例如:dc=example,dc=com。 约束限制: 最大长度64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| user_dn | 否 | String | 参数解释: 用于登录LDAP服务器执行搜索操作的服务账号DN(Distinguished Name,可分辨名称),以完成用户、用户组信息查询。 约束限制: 取值范围: 不涉及。 默认取值: 不涉及。 |
| password | 否 | String | 参数解释: LDAP认证密码,与user_dn对应的用户账号密码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| vpc_id | 否 | String | 参数解释: 文件系统所在的VPC ID,用于LDAP服务器与文件系统之间的网络通信。 约束限制: 仅在SFS Turbo支持多VPC的场景下需要填写,用于指定LDAP服务器可连通的VPC ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| filter_condition | 否 | String | 参数解释: 过滤条件。保留字段,暂不支持。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| backup_url | 否 | String | 参数解释: LDAP备节点的URL,固定格式为ldap://{ip_address}:{port_number}或ldaps://{ip_address}:{port_number},例如:ldap://192.168.0.1:60000。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| schema | 否 | String | 参数解释: LDAP目录的Schema类型,用于指定LDAP服务器的目录结构定义。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: RFC2307 |
| search_timeout | 否 | Integer | 参数解释: LDAP搜索的超时时间,单位为秒。 约束限制: 不涉及。 取值范围: 1~30 默认取值: 3 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| jobId | String | 参数解释: LDAP异步任务的ID,可通过查询job的状态详情接口查询job的执行状态。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 参数解释: 错误码,用于标识请求失败的原因。详细错误码请参见错误码。 取值范围: 不涉及。 |
| errMsg | String | 参数解释: 错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
请求示例
{
"url" : "ldap://192.168.xx.xx:60000",
"base_dn" : "dc=example,dc=com",
"user_dn" : "cn=admin,dc=example,dc=com",
"password" : "pwdxxxxxx",
"vpc_id" : "26f6b565-xxxx-xxxx-xxxx-03f0bd975433",
"backup_url" : "ldap://192.168.xx.xx:60000",
"schema" : "RFC2307",
"search_timeout" : 10
} 响应示例
状态码:200
{
"jobId" : "72362dxxxxa04d419dbd5e6d9fe5xxxx"
} 状态码:400
{
"errCode" : "SFS.TURBO.0001",
"errMsg" : "Invalid rule id"
} 状态码:500
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新中 |
| 400 | 错误响应 |
| 500 | 错误响应 |
错误码
请参见错误码。