调用SetGatewayLDAPInfo可以给云存储网关添加或者清除LDAP服务器信息。

使用该接口时,需要注意如下事项:

  • 如果您要添加一个LDAP服务器,请确保该LDAP服务信息有效。
    • 如果您要添加一个LDAP服务器信息,且已经存在一个LDAP服务器信息,那么原来的LDAP服务器信息会被新的LDAP服务器信息覆盖。
    • 如果您要清除LDAP服务器信息,请把enabled参数设置为false。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SetGatewayLDAPInfo

系统规定参数。取值:SetGatewayLDAPInfo。

GatewayId String gw-000eg44nmxbsfwbvq***

网关ID

BaseDN String dc=sgwt***,dc=local

连接LDAP服务器的BASE DN。取值范围:

  • 如果enabled为false,请忽略该字段。
  • 如果enabled为true,那么该字段必传。
RootDN String cn=admin,dc=sgwt***,dc=local

连接LDAP服务器的ROOT DN。取值范围:

  • 如果enabled为false,请忽略该字段。
  • 如果enabled为true,那么该字段必传。
Password String 123***

连接LDAP服务器的密码。取值范围:

  • 如果enabled为false,请忽略该字段。
  • 如果enabled为true,那么该字段必传。
ServerIp String 47.101.59.188

LDAP服务器的ip。取值范围:

  • 如果enabled为false,请忽略该字段。
  • 如果enabled为true,那么该字段必传,并输入有效的IP,只能包含数字和符号点(.)。
IsTls Boolean true

是否用TLS加密的方式连接LDAP服务器。取值范围:

  • true:使用TLS加密的方式连接LDAP服务器。
  • false:不用TLS加密的方式连接LDAP服务器。

默认值:false。

IsEnabled Boolean true

设置LDAP服务器的开关。取值范围:

  • true:设置LDAP服务器。
  • false:清理LDAP服务器信息。

默认值:false。

返回数据

名称 类型 示例值 描述
RequestId String 2D1834A3-5EF2-46E2-97F7-C9F0C264C1**

请求ID。

Success Boolean true

请求是否成功。

Code String 200

状态码。状态码为200表示请求成功。

Message String successful

请求结果描述。

TaskId String t-000eg44nmxbsyd9ak***

任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=SetGatewayLDAPInfo
&GatewayId=gw-000eg44nmxbsfwbvq***
&<公共请求参数>

正常返回示例

XML 格式

<SetGatewayLDAPInfoResponse>
      <TaskId>t-000eg44nmxbsyd9ak***</TaskId>
      <Message>successful</Message>
      <RequestId>2D1834A3-5EF2-46E2-97F7-C9F0C264C1**</RequestId>
      <Code>200</Code>
      <Success>true</Success>
</SetGatewayLDAPInfoResponse>

JSON 格式

{
    "TaskId": "t-000eg44nmxbsyd9ak***",
    "Message": "successful",
    "RequestId": "2D1834A3-5EF2-46E2-97F7-C9F0C264C1**",
    "Code": 200,
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidLDAPServerIp You must enter a valid IP address for the server. 服务器Ip不能为空,请输入一个有效ip。
400 EmptyLDAPPassword You must enter a valid password. 密码不能为空,请输入一个有效值。
400 InvalidLDAPBaseDN The specified Base DN is invalid. You must specify a valid Base DN. Base DN字段无效,请输入一个有效值。
400 InvalidLDAPRootDN The specified Root DN is invalid. You must specify a valid Root DN. Root DN字段无效,请输入一个有效值。
400 EmptyGatewayId You must enter a valid ID for the gateway. 网关ID不能为空。
400 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. 网关不存在,请确认输入参数是否正确。
400 GatewayInOperation The gateway is processing requests . Try again later. 网关正在进行操作中,请稍后再试。
500 InternalError Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket. 内部错误,请重试。如果多次尝试失败,请提交工单。

访问错误中心查看更多错误码。