GetInstanceADAuthServer - 查询堡垒机实例上AD认证的配置信息

查询堡垒机实例上AD认证的配置信息。

接口说明

使用说明

本接口用于查询堡垒机实例上 AD 认证的配置信息。通过堡垒机的 AD 认证功能,可以将 AD 服务器的用户同步到堡垒机。同步成功后,用户可通过堡垒机运维服务器。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-bastionhost:GetInstanceADAuthServerget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

要查询的堡垒机实例的 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastionhost-cn-st220aw****
RegionIdstring

要查询的堡垒机实例的地域 ID。

说明 地域 ID 和地域名称的对应关系,请参见地域和可用区
cn-hangzhou

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50
ADobject

AD 认证的配置信息。

Accountstring

服务器账号的 DN。

cn=Manager,dc=test,dc=com
BaseDNstring

连接 AD 服务器的 BASE DN。

dc=test,dc=com
Domainstring

AD 服务器上的域。

domain
EmailMappingstring

AD 服务器上对应的用户邮箱的字段名称。

emailAttr
Filterstring

用户的筛选条件。

(&(objectClass=top))
IsSSLboolean

是否支持 SSL。取值:

  • true:是
  • false:否
true
MobileMappingstring

AD 服务器上对应的用户手机号的字段名称。

mobileAttr
NameMappingstring

AD 服务器上对应的用户名称的字段名称。

nameAttr
HasPasswordboolean

是否设置密码。取值:

  • true:设置密码
  • false:未设置密码
true
Portlong

服务器的端口。

389
Serverstring

服务器的地址。

192.168.XX.XX
StandbyServerstring

备用服务器的地址。

192.168.XX.XX

示例

正常返回示例

JSON格式

{
  "RequestId": "89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50",
  "AD": {
    "Account": "cn=Manager,dc=test,dc=com",
    "BaseDN": "dc=test,dc=com",
    "Domain": "domain",
    "EmailMapping": "emailAttr",
    "Filter": "(&(objectClass=top))",
    "IsSSL": true,
    "MobileMapping": "mobileAttr",
    "NameMapping": "nameAttr",
    "HasPassword": true,
    "Port": 389,
    "Server": "192.168.XX.XX",
    "StandbyServer": "192.168.XX.XX"
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
500InternalErrorAn unknown error occurred.未知错误

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