SetGatewayADInfo - 添加或清除AD服务器信息_云存储网关(CSG)-阿里云帮助中心

接口说明

调用该接口时，您需要注意：

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:SetGatewayADInfo

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-000eg44nmxbsfwbv****
Username	string	否	连接 AD 服务器的用户名。可能值： enabled 为 false，请忽略该字段。 enabled 为 true，该字段必传。	ale****
Password	string	否	连接 AD 服务器的密码。可能值： enabled 为 false，请忽略该字段。 enabled 为 true，该字段必传。	12****
ServerIp	string	否	AD 服务器的 IP。可能值： enabled 为 false，请忽略该字段。 enabled 为 true，该字段必传，并输入有效的 IP，只能由数字和半角句号（.）组成。	12.12.x.x
IsEnabled	boolean	否	设置 AD 服务器的开关。可能值： true：设置 AD 服务器信息。 false（默认）：清理 AD 服务器信息。重要需要开启 AD 时，所有参数都必填。需要关闭 AD 时，只需要指定 IsEnabled 为 false 即可。	true

返回参数

名称	类型	描述	示例值
	object
TaskId	string	任务 ID。	t-000c6hshwukkcfn****
Message	string	请求结果描述。	successful
RequestId	string	请求 ID。	89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

{
  "TaskId": "t-000c6hshwukkcfn****",
  "Message": "successful",
  "RequestId": "89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
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.	内部错误，请重试。如果多次尝试失败，请提交工单。

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

变更历史

更多信息，参考变更详情。