Reset an account password using the ResetAccountPassword API - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

Note

Only Tair (Redis OSS-compatible) instances of Redis 4.0 or later are supported.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:ResetAccountPassword

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance to which the account belongs.	r-bp1zxszhcgatnx****
AccountName	string	Yes	The name of the account. You can call the DescribeAccounts operation to obtain the name of the account.	demoaccount
AccountPassword	string	Yes	The new password for the account. The password must be 8 to 32 characters in length. It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `!@ # $ % ^ & * ( ) _ + - =`	uWonno_221****
SourceBiz	string	No	This parameter is used only for internal maintenance. You do not need to specify this parameter.	SDK

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	8BE02313-5395-4EBE-BAE7-E90A053F****

Examples

Success response

JSON format

{
  "RequestId": "8BE02313-5395-4EBE-BAE7-E90A053F****"
}

Error response

JSON format

{
	"RequestId": "8BE02313-5395-4EBE-BAE7-E90A053F1E07"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAccountName.Duplicate	Specified AccountName already exists in this instance.	The error message returned because the account already exists.
400	InvalidAccountName.Format	Specified AccountName is not valid.
400	InvalidEngineVersion.Format	Current EngineVersion does not support operations.	The operation is not supported while the instance runs this engine version.
400	InvalidAccountPassword.Format	Specified AccountPassword is not valid.
400	TaskExists	Specified task have existed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.