Use ModifyInstanceAttribute to change instance name, password, and release protection - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

You can also modify instance attributes in the Tair (Redis OSS-compatible) console. For more information, see Change or reset the password.

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:ModifyInstanceAttribute

update

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****
InstanceName	string	No	The new name of the instance. The name must be 2 to 80 characters in length and start with a letter. It cannot contain spaces or the following special characters: `@ / : = " < > { [ ] }`	newinstancename
NewPassword	string	No	The new password for the default account. The default account is named after the instance ID. Example: r-bp10noxlhcoim2**. Note** The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. These special characters include `! @ # $ % ^ & * ( ) _ + - =`	uW8+nsrp
InstanceReleaseProtection	boolean	No	Specifies whether to enable release protection for the instance. Valid values: true: enables release protection. false: disables release protection. Note This parameter is available only for pay-as-you-go instances.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76

Examples

Success response

JSON format

{
  "RequestId": "8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76"
}

Error response

JSON format

{
  "RequestId":"EFC9161F-15E3-4A6E-8A99-C09916D1F464"
}

Error codes

HTTP status code	Error code	Error message
400	MissingParameter	InstanceName or NewPassword at least one is mandatory for this action.
400	InvalidInstanceName.Malformed	The Specified parameter InstanceName is not valid.
400	InvalidPassword.Malformed	The Specified parameter NewPassword 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.