You can call ModifyAccountDescription to modify the description of an account of an ApsaraDB for Redis instance.

Note The engine version of the ApsaraDB for Redis instance must be Redis 4.0 and later.

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 No ModifyAccountDescription

The operation that you want to perform. Set the value to ModifyAccountDescription.
AccountDescription String Yes this is a test account

The description of the account.

  • It must start with a Chinese character or a letter and cannot start with http:// or https://.
  • The description can contain Chinese characters, letters, underscores (_), hyphens (-), and digits.
  • The description must be 2 to 256 characters in length.
AccountName String Yes demoaccount

The name of the database account.

  • It must start with a lowercase letter.
  • It can contain lowercase letters, digits, and underscores (_).
  • The account must be 1 to 16 characters in length.
InstanceId String Yes r-bp1xxxxxxxxxxxxx

The ID of the instance.

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=ModifyAccountDescription
&InstanceId=r-bp1xxxxxxxxxxxxx
&AccountName=demoaccount
&AccountDescription=this is a test account
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

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

Error codes

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