You need to enable JavaScript to run this app.
Cache for Redis

Cache for Redis

  • Documentation
    • Cache for RedisDevelopment reference (Control plane)API referenceAccount managementListDBAccount
Copy page
Download PDF
Account management
ListDBAccount
Copy page
Download PDF
ListDBAccount

Call the ListDBAccount API to query the information of specified accounts or all accounts for a Redis instance, including the account name and account role.

Request type

Synchronous request.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
redis-cn0212gzmh2xs****

Instance ID.

tip

You can call DescribeDBInstances to query the basic information of all Redis instances in a target region, including instance IDs.

AccountName
String
No
test1

Account name.

tip

If this parameter is blank, all account information in current instance is returned.

Response parameters

Name
Type
Example
Description
Accounts
Object[]
List of account information.

Sample request 

POST https://redis.cn-beijing.volcengineapi.com/?Action=ListDBAccount&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "202204152005100102120451971763****",
        "Action": "ListDBAccount",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Accounts": [
            {
                "AccountName": "default",
                "AccountStatus": "Available",
                "Description": "默认账号",
                "InstanceId": "redis-cn0212gzmh2xs****",
                "RoleName": "Administrator"
            }
        ]
    }
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.07.29 22:02:16