All Products
Search
Document Center

Bastionhost:ModifyInstanceTwoFactor

Last Updated:Apr 18, 2024

Modifies the settings of two-factor authentication on a bastion host.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:ModifyInstanceTwoFactorWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the bastion host.

Note You can call the DescribeInstances operation to query the ID of the bastion host.
bastionhost-cn-st220aw****
RegionIdstringNo

The region ID of the bastion host.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-hangzhou
EnableTwoFactorstringNo

Specifies whether to enable two-factor authentication. Valid values:

  • true: enables two-factor authentication.
  • false: disables two-factor authentication.
true
TwoFactorMethodsstringNo

One or more methods that are used to send a verification code if two-factor authentication is enabled. If you set the EnableTwoFactor parameter to true, you must specify at least one method. Valid values:

  • sms: text message
  • email: email
  • dingtalk: Notice in DingTalk
["sms"]
SkipTwoFactorTimestringNo

The ID of the request, which is used to locate and troubleshoot issues.

1

Response parameters

ParameterTypeDescriptionExample
object

The operation that you want to perform. Set the value to ModifyInstanceTwoFactor.

RequestIdstring

The duration within which two-factor authentication is not required after a local user passes two-factor authentication. Valid values: 0 to 168. Unit: hours. If you set this parameter to 0, the local user must pass two-factor authentication every time the local user logs on to the bastion host.

9CE1A352-15E9-5EB4-B589-87A8DEECB20D

Examples

Sample success responses

JSONformat

{
  "RequestId": "9CE1A352-15E9-5EB4-B589-87A8DEECB20D"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the Service error codes.