文档

SetGatewayADInfo

更新时间:

调用SetGatewayADInfo接口可以给云存储网关添加或清除AD服务器信息。

调用该接口时,您需要注意:

  • 如果您要添加一个AD服务器,请确保该AD服务信息有效,并可以被网关的DNS解析访问,您可以通过SetGateWayDNS接口设置云存储网关的DNS。
  • 如果您要添加一个AD服务器信息,且已经存在一个AD服务器信息,那么原来的AD服务器信息会被新的AD服务器信息覆盖。
  • 如果您要清除AD服务器信息,请把enabled参数设置为false。

请求参数

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

系统规定参数。取值为SetGatewayADInfo。

GatewayId String gw-000eg44nmxbsfwbv****

网关ID。

Username String ale****

连接AD服务器的用户名。可能值:

  • enabled为false,请忽略该字段。
  • enabled为true,该字段必传。
Password String 12****

连接AD服务器的密码。可能值:

  • enabled为false,请忽略该字段。
  • enabled为true,该字段必传。
ServerIp String 12.12.x.x

AD服务器的IP。可能值:

  • enabled为false,请忽略该字段。
  • enabled为true,该字段必传,并输入有效的IP,只能由数字和半角句号(.)组成。
IsEnabled Boolean true

设置AD服务器的开关。可能值:

  • true:设置AD服务器信息。
  • false(默认):清理AD服务器信息。

返回数据

名称 类型 示例值 描述
TaskId String t-000c6hshwukkcfn****

任务ID。

Message String successful

请求结果描述。

RequestId String 89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**

请求ID。

Code String 200

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

Success Boolean true

请求是否成功。

示例

请求示例

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

正常返回示例

XML格式

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

<SetGatewayADInfoResponse>
    <TaskId>t-000c6hshwukkcfn****</TaskId>
    <Message>successful</Message>
    <RequestId>0F069495-0184-41B9-9D1E-6E4E921D2**</RequestId>
    <Code>200</Code>
    <Success>true</Success>
</SetGatewayADInfoResponse>

JSON格式

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

{
  "TaskId" : "t-000c6hshwukkcfn****",
  "Message" : "successful",
  "RequestId" : "0F069495-0184-41B9-9D1E-6E4E921D2**",
  "Code" : 200,
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
400 EmptyADUserName You must enter a valid username. 用户名不能为空,请输入一个有效值。
400 EmptyADPassword You must enter a valid password. 密码不能为空,请输入一个有效值。
400 InvalidADServerIp The specified IP address for the server is invalid. You must enter a valid IP address. 服务器IP不能为空,请输入一个有效IP。
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. 内部错误,请重试。如果多次尝试失败,请提交工单。

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