调用SetGatewayLDAPInfo给云存储网关添加/清除LDAP服务器信息

使用该接口时，需要注意如下事项：

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	SetGatewayLDAPInfo	系统规定参数。取值为SetGatewayLDAPInfo。
GatewayId	String	是	gw-000eg44nmxbsfwbv****	网关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服务器。
IsEnabled	Boolean	否	true	设置LDAP服务器的开关。取值范围： true：设置LDAP服务器。 false（默认）：清理LDAP服务器信息。

返回数据

名称	类型	示例值	描述
TaskId	String	t-000eg44nmxbsyd9a****	任务ID。
Message	String	successful	请求结果描述。
RequestId	String	2D1834A3-5EF2-46E2-97F7-C9F0C264C1**	请求ID。
Code	String	200	状态码。状态码为200表示请求成功。
Success	Boolean	true	请求是否成功。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TaskId" : "t-000eg44nmxbsyd9a****",
  "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.	内部错误，请重试。如果多次尝试失败，请提交工单。

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