调用GetInstanceTwoFactor接口查询堡垒机实例的双因子认证的配置信息。

使用说明

本接口用于查询堡垒机实例的双因子认证的配置信息。双因子认证是在本地用户登录堡垒机时发送验证码,对用户身份进行二次认证,可以有效降低账户泄露等情况带来的安全风险。

QPS限制

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

调试

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

请求参数

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

要执行的操作。取值:GetInstanceTwoFactor

InstanceId String bastionhost-cn-st220aw****

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

说明 您可以调用DescribeInstances接口获取该参数。
RegionId String cn-hangzhou

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

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

返回数据

名称 类型 示例值 描述
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

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

Config Object

双因子认证的配置信息。

EnableTwoFactor Boolean true

是否开启了双因子。取值:

  • true:是
  • false:否
TwoFactorMethods Array of String sms

开启双因子认证时验证码的发送方式。取值:

  • sms:短信
  • email:邮件
  • dingtalk 钉钉工作通知
SkipTwoFactorTime Long 1

双因子认证成功后,后续登录堡垒机时跳过双因子认证的时间。取值范围为[0,168],单位为小时。

说明 0表示不跳过,即每次登录堡垒机都需要双因子认证。

示例

请求示例

http(s)://[Endpoint]/?Action=GetInstanceTwoFactor
&InstanceId=bastionhost-cn-st220aw****
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetInstanceTwoFactorResponse>
    <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
    <Config>
        <EnableTwoFactor>true</EnableTwoFactor>
        <TwoFactorMethods>sms</TwoFactorMethods>
        <SkipTwoFactorTime>1</SkipTwoFactorTime>
        <MessageLanguage>zh-cn</MessageLanguage>
    </Config>
</GetInstanceTwoFactorResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Config" : {
    "EnableTwoFactor" : true,
    "TwoFactorMethods" : [ "sms" ],
    "SkipTwoFactorTime" : 1,
    "MessageLanguage" : "zh-cn"
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter The argument is invalid. 参数错误
500 InternalError An unknown error occurred. 未知错误

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