ModifyAccountDescription - Tair (Redis® OSS-Compatible)

Modifies the description of an account for an ApsaraDB for Redis instance.

Operation description

Note This operation is supported only for instances that run Redis 4.0 or later.

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:ModifyAccountDescription	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****
AccountName	string	Yes	The username of the account. You can call the DescribeAccounts operation to query the username of the account.	demoaccount
AccountDescription	string	Yes	The description of the account. The description must start with a letter and cannot start with `http://` or `https://`. The description can contain letters, digits, underscores (_), and hyphens (-). The description must be 2 to 256 characters in length.	testescription

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidEngineVersion.Format	Current EngineVersion does not support operations.	The operation is not supported while the instance runs this engine version.
400	InvalidAccountDescription.Format	Specified AccountDescription is not valid.	-

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

Change history

Change time	Summary of changes	Operation
2024-07-11	The Error code has changed. The request parameters of the API has changed	View Change Details