All Products
Search
Document Center

ApsaraDB for Redis:ModifyAccountDescription

Last Updated:May 28, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:ModifyAccountDescriptionWRITE
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
AccountNamestringYes

The username of the account. You can call the DescribeAccounts operation to query the username of the account.

demoaccount
AccountDescriptionstringYes

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

ParameterTypeDescriptionExample
object
RequestIdstring

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 codeError codeError messageDescription
400InvalidEngineVersion.FormatCurrent EngineVersion does not support operations.The operation is not supported while the instance runs this engine version.
400InvalidAccountDescription.FormatSpecified AccountDescription is not valid.-

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