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

Cache for Redis

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

Call the DescribeDBInstanceAclCommands API to query the list of commands supported by the specified command category in 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.

Category
String
Yes
admin

Specify the command category to be queried.

tip

  • Only one command support list under a command category is allowed to be queried each time.
  • Call the DescribeDBInstanceAclCategories API to query the details of the command categories supported by the target Redis instance.

Response parameters

Name
Type
Example
Description
Commands
String[]
["client","cluster","config","monitor"]

The list of commands supported under the current command category.

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=DescribeDBInstanceAclCommands&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json
X-Date: 20240926T114317Z
Authorization: HMAC-SHA256 Credential=AKLTO*****U2NGM/20240926/cn-beijing/Redis/request, SignedHeaders=x-content-sha256;x-date, Signature=c220b*****e0941
{
    "InstanceId": "redis-cnlfqfxzk8zxt****",
    "Category": "admin"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "20240926194317097E9108DCFD7EC29192-88****",
        "Action": "DescribeDBInstanceAclCommands",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Commands": [
            "client",
            "cluster",
            "config",
            "monitor"
        ]
    }
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.07.02 15:43:26