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

Cache for Redis

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

Call the DescribeDBInstanceAclCategories API to query the command categories supported by the target Redis instance.

Request type

Synchronous request.

Request parameters

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

Instance ID.

tip

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

Response parameters

Name
Type
Example
Description
Categories
String[]
["keyspace","read","write","set","sortedset","list","hash","string","bitmap","hyperloglog","geo","stream","pubsub","admin","fast","slow","blocking","dangerous","connection","transaction","scripting"]

The command categories supported by the current instance.

tip

Cache for Redis provides four roles by default: Administrator, NotDangerous, ReadWrite, and ReadOnly. The ACL rules of each role are different, and the supported command categories and corresponding commands are also different. For more details, refer to ACL Syntax.

Sample request 

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceAclCategories&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json
X-Date: 20240926T113612Z
Authorization: HMAC-SHA256 Credential=AKLTO*****U2NGM/20240926/cn-beijing/Redis/request, SignedHeaders=x-content-sha256;x-date, Signature=e769f*****bf440
{
    "InstanceId": "redis-cnlfqfxzk8zxt****"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "20240926193612F1B41A449DB5EFC04A19-13****",
        "Action": "DescribeDBInstanceAclCategories",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Categories": [
            "keyspace",
            "read",
            "write",
            "set",
            "sortedset",
            "list",
            "hash",
            "string",
            "bitmap",
            "hyperloglog",
            "geo",
            "stream",
            "pubsub",
            "admin",
            "fast",
            "slow",
            "blocking",
            "dangerous",
            "connection",
            "transaction",
            "scripting"
        ]
    }
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.07.02 15:43:26