SetGatewayADInfo_云存储网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

  • 如果您要添加一个 AD 服务器,请确保该 AD 服务信息有效,并可以被网关的 DNS 解析访问,您可以通过 SetGateWayDNS 接口设置云存储网关的 DNS。

  • 如果您要添加一个 AD 服务器信息,且已经存在一个 AD 服务器信息,那么原来的 AD 服务器信息会被新的 AD 服务器信息覆盖。

  • 如果您要清除 AD 服务器信息,请把 enabled 参数设置为 false。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
hcs-sgw:SetGatewayADInfo
Update
全部资源
*

请求参数

字段名称字段详情
GatewayIdstring

网关 ID。

示例值:gw-000eg44nmxbsfwbv****参考取值来源:
    ModifyGateway
    CreateGateway
    DescribeGateways
Usernamestring

连接 AD 服务器的用户名。可能值:展开详情

示例值:ale****
Passwordstring

连接 AD 服务器的密码。可能值:展开详情

示例值:12****
ServerIpstring

AD 服务器的 IP。可能值:展开详情

示例值:12.12.x.x
IsEnabledboolean

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

示例值:true

返回参数

字段名称字段详情
TaskIdstring

任务 ID。

示例值:t-000c6hshwukkcfn****
Messagestring

请求结果描述。

示例值:successful
RequestIdstring

请求 ID。

示例值:89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**
Codestring

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

示例值:200
Successboolean

请求是否成功。

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
400
EmptyGatewayId
You must enter a valid ID for the gateway.诊断
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.诊断

变更历史

暂无变更历史

相关示例