All Products
Search
Document Center

ApsaraDB for Redis:DescribeAccounts

Last Updated:May 28, 2024

Queries all accounts or a specified account of an ApsaraDB for Redis instance.

Operation description

Note Only ApsaraDB for Redis instances of Redis 4.0 or later are supported.

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:DescribeAccountsREAD
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
AccountNamestringNo

The name of the account that you want to query.

demoaccount

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6C9E114C-217C-4118-83C0-B4070222****
Accountsobject []

Details about returned accounts of the instance.

AccountDescriptionstring

The description of the account.

testdec
InstanceIdstring

The ID of the instance.

r-bp10noxlhcoim2****
AccountTypestring

The type of the account. Valid values:

  • Normal: standard account
  • Super: super account
Normal
AccountStatusstring

The state of the account. Valid values:

  • Unavailable: The account is unavailable.
  • Available: The account is available.
Available
AccountNamestring

The name of the account.

demoaccount
DatabasePrivilegesobject []

Details about account permissions.

AccountPrivilegestring

The permission of the account. Default value: RoleReadWrite. Valid values:

  • RoleReadOnly: The account has the read-only permissions.
  • RoleReadWrite: The account has the read and write permissions.
RoleReadWrite

Examples

Sample success responses

JSONformat

{
  "RequestId": "6C9E114C-217C-4118-83C0-B4070222****",
  "Accounts": {
    "Account": [
      {
        "AccountDescription": "testdec",
        "InstanceId": "r-bp10noxlhcoim2****",
        "AccountType": "Normal",
        "AccountStatus": "Available",
        "AccountName": "demoaccount",
        "DatabasePrivileges": {
          "DatabasePrivilege": [
            {
              "AccountPrivilege": "RoleReadWrite"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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