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

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

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

调试

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

请求参数

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

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

GatewayId String gw-000eg44nmxbsfwbvq***

网关ID。

Username String alex***

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

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

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

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

AD服务器的ip。

可能值:

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

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

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

    默认值:false。

返回数据

名称 类型 示例值 描述
RequestId String 89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**

请求ID。

Success Boolean true

请求是否成功。

Code String 200

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

Message String successful

请求结果描述。

TaskId String t-000c6hshwukkcfn3k**

任务ID。

示例

请求示例

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

正常返回示例

XML 格式

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

JSON 格式

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

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