All Products
Search
Document Center

Tair:ModifyInstanceVpcAuthMode

Last Updated:Feb 20, 2024

Enables or disables password-free access for an ApsaraDB for Redis instance. This way, you can connect to a database in a convenient and secure manner.

Operation description

When the password-free access feature is enabled, Elastic Compute Service (ECS) instances in the same virtual private cloud (VPC) can connect to the ApsaraDB for Redis instance without a password. You can also use the username and password to connect to the ApsaraDB for Redis instance.

Note The ApsaraDB for Redis instance is deployed in a VPC. For more information, see Enable password-free access.

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
kvstore:ModifyInstanceVpcAuthModeWrite
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
  • kvstore:VpcAuthMode
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
VpcAuthModestringYes

Specifies whether to disable password-free access. Valid values:

  • Open: disables password-free access.
  • Close: enables password-free access.

**

Description Default value: Open.

Close

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

ABAF95F6-35C1-4177-AF3A-70969EBD****

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABAF95F6-35C1-4177-AF3A-70969EBD****"
}

Error codes

HTTP status codeError codeError messageDescription
403ParamNotSupportedForCurrentVersionParameter is not supported for current version.The error message returned because modifications to parameter values are not supported for the current engine version.

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

Change history

Change timeSummary of changesOperation
No change history