1. 接口描述
接口请求域名： bh.tencentcloudapi.com 。
修改LDAP配置信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyLDAPSetting。 |
| Version | 是 | String | 公共参数，本接口取值：2023-04-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Enable | 是 | Boolean | 是否开启LDAP认证，false-不开启，true-开启 示例值：true |
| Ip | 否 | String | 服务器地址 示例值：10.10.10.1 |
| IpBackup | 否 | String | 备用服务器地址 示例值：10.10.10.2 |
| Port | 否 | Integer | 服务端口 示例值：389 |
| EnableSSL | 否 | Boolean | 是否开启SSL，false-不开启，true-开启 示例值：true |
| BaseDN | 否 | String | Base DN 示例值：base-dn |
| AdminAccount | 否 | String | 管理员账号 示例值：admin |
| AdminPassword | 否 | String | 管理员密码 示例值：adminpwd |
| AttributeUser | 否 | String | 用户属性 示例值：attr-user |
| AttributeUserName | 否 | String | 用户名属性 示例值：attr-username |
| AutoSync | 否 | Boolean | 自动同步，false-不开启，true-开启 示例值：true |
| Overwrite | 否 | Boolean | 覆盖用户信息，false-不开启，true-开启 示例值：true |
| SyncPeriod | 否 | Integer | 同步周期，30～60000之间的整数 示例值：30 |
| SyncAll | 否 | Boolean | 是否同步全部，false-不开启，true-开启 示例值：true |
| SyncUnitSet.N | 否 | Array of String | 同步OU列表，SyncAll为false时必传 示例值：[] |
| AttributeUnit | 否 | String | 组织单元属性 示例值：unit |
| AttributeRealName | 否 | String | 用户姓名属性 示例值：realname |
| AttributePhone | 否 | String | 手机号属性 示例值：phone |
| AttributeEmail | 否 | String | 邮箱属性 示例值：email |
| DomainId | 否 | String | 网络域Id 示例值：net-default |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改LDAP配置信息
修改LDAP配置信息
输入示例
POST / HTTP/1.1
Host: bh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLDAPSetting
<公共请求参数>
{
"Enable": true,
"AdminAccount": "admin",
"AttributeEmail": "bhtets@email.com",
"AdminPassword": "password",
"AutoSync": true,
"Ip": "172.168.0.1",
"BaseDN": "bhtest-dn",
"SyncPeriod": 1,
"SyncAll": true,
"EnableSSL": true,
"AttributeRealName": "attrRealName",
"SyncUnitSet": [
""
],
"IpBackup": "",
"AttributeUser": "user",
"AttributeUserName": "testusername",
"AttributePhone": "phone",
"AttributeUnit": "unit",
"Port": 1,
"Overwrite": true
}输出示例
{
"Response": {
"RequestId": "9e5a83b7-564a-4831-8111-28a4ec740c61"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermission | UnauthorizedOperation.NoPermission |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
