DescribeGatewayADInfo - 获取网关上配置的AD服务器信息

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGatewayADInfo

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-000eg44nmxbsfwbvq***

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	BB2D3121-8271-5DD7-9957-D52433FF****
Message	string	请求结果描述。	successful
DomainName	string	连接 AD 服务器的域名。	ad.aliyundoc.com
IsEnabled	boolean	AD 服务器是否生效。可能值： true：AD 服务器生效。 false：AD 服务器没有生效。	true
Username	string	域管理员用户。	administrator
ServerIp	string	AD 服务器的 IP。	47.101..*
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	调用结果，返回值如下： true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "BB2D3121-8271-5DD7-9957-D52433FF****",
  "Message": "successful",
  "DomainName": "ad.aliyundoc.com",
  "IsEnabled": true,
  "Username": " administrator",
  "ServerIp": "47.101.**.***",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	网关不存在，请确认输入参数是否正确。
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	网关正在升级中，请稍后再试。
400	GatewayInOperation	The gateway is processing requests . Try again later.	网关正在进行操作中，请稍后再试。
400	GatewayStatusRunningRequired	The gateway is not in the Running state. Try again later.	需要网关为启动状态，请稍后再试。

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

变更历史

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