Use DescribeAccounts to query account details - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries the information about an account in a specified ApsaraDB for Tair (Redis® OSS-Compatible) database instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeAccounts

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	r-bp1zxszhcgatnx****
AccountName	string	No	The name of the account to query.	demoaccount
		No	The fuzzy match string for the account name.	test
		No	The page number.	1
		No	The number of entries per page.	100

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6C9E114C-217C-4118-83C0-B4070222****
Accounts	object
Account	array<object>	The list of account information for the instance.
	array<object>	The account details.
AccountDescription	string	The description of the account.	testdec
InstanceId	string	The instance ID.	r-bp10noxlhcoim2****
AccountType	string	The account type. Valid values: Normal: standard account. Super: superuser account.	Normal
AccountStatus	string	The account status. Valid values: Unavailable: unavailable. Available: available.	Available
AccountName	string	The account name.	demoaccount
DatabasePrivileges	object
DatabasePrivilege	array<object>	The list of account privileges.
	object	The privilege details of the account.
AccountPrivilege	string	The account privilege. Valid values: RoleReadOnly: read-only permission. RoleReadWrite: read and write permission. This is the default value.	RoleReadWrite
Parameters	string	The account parameters.	{"access-db-id":"1","cu-limit":"10"}
PageNumber	integer	The page number.	100
PageSize	integer	The number of entries per page.	1
TotalCount	integer	The total number of entries.	10

Examples

Success response

JSON format

{
  "RequestId": "6C9E114C-217C-4118-83C0-B4070222****",
  "Accounts": {
    "Account": [
      {
        "AccountDescription": "testdec",
        "InstanceId": "r-bp10noxlhcoim2****",
        "AccountType": "Normal",
        "AccountStatus": "Available",
        "AccountName": "demoaccount",
        "DatabasePrivileges": {
          "DatabasePrivilege": [
            {
              "AccountPrivilege": "RoleReadWrite"
            }
          ]
        },
        "Parameters": "{\"access-db-id\":\"1\",\"cu-limit\":\"10\"}"
      }
    ]
  },
  "PageNumber": 100,
  "PageSize": 1,
  "TotalCount": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.