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

The engine version of the ApsaraDB for Redis instance must be Redis 4.0 or above.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Example Description
AccountDescription String Yes this is a test account

The description of the account.

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

The name of the account. The name must start with a lowercase letter and can contain lowercase letters, digits, and underscores (_). The name can be 1 to 16 characters in length.

InstanceId String Yes r-bp1xxxxxxxxxxxxx

The ID of the instance to which the account belongs.

Action String No ModifyAccountDescription

The operation that you want to perform. Set this parameter to ModifyAccountDescription.

AccessKeyId String No Lxxxxxxxxxxxxxxw

The AccessKey ID that Alibaba Cloud provides for you to access services.

Response parameters

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

The ID of the request.

Examples

Sample request


https://r-kvstore.aliyuncs.com/
? Action=ModifyAccountDescription
&InstanceId=r-bp1xxxxxxxxxxxxx
&AccountName=demoaccount
&AccountDescription=this is a test account
&<Common request parameters>

Sample success response

XML format

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

JSON format

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

Error codes

View error codes.