Docs

Cache for Redis

Account management

DescribeDBInstanceAclCategories

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

Request type

Synchronous request.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameters	Type	Required	Example	Description
InstanceId	String	Yes	redis-cnlfqfxzk8zxt9ghz	Instance ID. tip You can call the DescribeDBInstances API to query the basic information of all Redis instances in the target region, including the instance ID.

Response parameters

Parameters	Type	Example	Description
Categories	Array of String	["keyspace","read","write","set","sortedset","list","hash","string","bitmap","hyperloglog","geo","stream","pubsub","admin","fast","slow","blocking","dangerous","connection","transaction","scripting"]	Command categories supported by the current instance. tip Cache for Redis provides five roles by default: Administrator, NotDangerous, ReadWrite, ReadOnly, and NotWrite. Each role has different ACL rules, as well as different supported command categories and corresponding commands. For more details, refer to ACL Syntax.

Example

Request example

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-cnlfqfxzk8zxt9ghz"​
}​

Response example

{​
  "ResponseMetadata": {​
    "RequestId": "20240926193612F1B41A449DB5EFC04A19-13880a",​
    "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 code

For more details, see Error code.

Last updated: 2026.09.21 14:57:31