ModifyInstanceAttribute - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

Changes the information of an ApsaraDB for Redis instance, such as the name and password.

Operation description

You can also modify the information of an instance in the ApsaraDB for Redis console. For more information, see Change or reset the password.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:ModifyInstanceAttribute	update	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	none	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. The name must start with a letter and cannot contain spaces and 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	The release protection state of the instance. Valid values: true: enabled false: disabled Note This parameter is available only for pay-as-you-go instances.	true

Response parameters

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

Examples

Sample success responses

JSONformat

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

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.

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

Change history

Change time	Summary of changes	Operation
2023-03-02	The Error code has changed	View Change Details