Modifies the attributes of an ApsaraDB for Redis instance, such as the name, password, and state of release protection.

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyInstanceAttribute

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

RegionId String No cn-hangzhou

The region ID the instance.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance.

InstanceName String No newinstancename

The name of the new instance. The name must be 2 to 80 characters in length and start with a letter. The name cannot contain spaces or special characters. Special characters include @ / : = " < > { [ ] }.

NewPassword String No uW8+nsrp

The new password for the default account. The default account is named after the instance ID. Default account 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. Special characters include ! @ # $ % ^ & * ( ) _ + - =
InstanceReleaseProtection Boolean No true

The release protection state of the instance. Valid values:

  • true: The release protection is enabled.
  • false: The release protection is disabled.
Note This parameter is available only for pay-as-you-go instances.

Response parameters

Parameter Type Example Description
RequestId String 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=ModifyInstanceAttribute
&InstanceId=r-bp1zxszhcgatnx****
&InstanceName=demo
&NewPassword=uW8+nsrp
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyInstanceAttributeResponse>
    <RequestId>8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76</RequestId>
</ModifyInstanceAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the Error Center.