GetInstanceTwoFactor - 查询堡垒机实例的双因子认证的配置信息 - 运维安全中心（堡垒机）

查询堡垒机实例的双因子认证的配置信息。

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-bastionhost:GetInstanceTwoFactor	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	要查询的堡垒机实例的 ID。说明您可以调用 DescribeInstances 接口获取该参数。	bastionhost-cn-st220aw****
RegionId	string	否	要查询的堡垒机实例的地域 ID。说明地域 ID 和地域名称的对应关系，请参见地域和可用区。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Config	object	双因子认证的配置信息。
EnableTwoFactor	boolean	是否开启了双因子。取值： true：是 false：否	true
TwoFactorMethods	array	已配置的双因子认证方式列表。
Item	string	开启双因子认证时验证码的发送方式。取值： sms：短信 email：邮件 dingtalk 钉钉工作通知 totp：手机 OTP 令牌 gmusbkey：国密 USBKEY	sms
SkipTwoFactorTime	long	双因子认证成功后，后续登录堡垒机时跳过双因子认证的时间。取值范围为`[0,168]`，单位为小时。说明 0 表示不跳过，即每次登录堡垒机都需要双因子认证。	1

示例

正常返回示例

JSON格式

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

错误码

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

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