Message Queue for RocketMQ
Message Queue for RocketMQ
Document
- Documentation
Message Queue for RocketMQAPI ReferenceKey managementDescribeAccessKeys - Query key list
Copy page
Download PDFKey management
DescribeAccessKeys - Query key list
Copy pageDownload PDFDescribeAccessKeys - Query key list
Call the DescribeAccessKeys API to query the RocketMQ key list.
Instructions
This API allows you to view the RocketMQ key list for a specified instance and also check the basic information for a particular key.
Note
Request frequency: This API limits requests to 40 times per second. Per-user request frequency limit is 8 times per second.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.
Action string required Example value: DescribeAccessKeys
Operation to perform, value: DescribeAccessKeys.
Version string required Example value: 2023-01-01
API version, value: 2023-01-01.
InstanceId string required Example: rocketmq-cnai1f0c29ca****
Instance ID.
PageNumber integer required Example value: 1
Page number of the list, minimum value is 1.
PageSize integer required Example value: 10
The number of entries per page in the list. Valid range: 1–100.
AccessKey string Optional Example value: 2QdEgrGc97AL1p38Fq13****
Perform an exact search using the AccessKey ID.
Response parameters
Only the unique response parameters of this API are listed below. For more details, see response structure.
Total integer Example value: 1
Total number of RocketMQ keys.
AccessKeysInfo object[] Example value: /
RocketMQ key information.
AccessKey string Example value: 2QdEgrGc97AL1p38Fq13****
AccessKey ID for RocketMQ keys.
AclConfigJson string Example value: {\"topicPerms\":{\"RMQ_SYS_TRACE_TOPIC\":\"PUB\",\"rocketmq123\":\"PUB|SUB\"},\"groupPerms\":{\"GID_test\":\"PUB|SUB\"}}
All ACL configuration information for RocketMQ keys.
Actived boolean Example value: true
Status of the RocketMQ key.
- true: enabled
- false: not enabled
AllAuthority string Example value: SUB
Default permission for RocketMQ keys.
- ALL: Publish and subscribe permissions granted
- PUB: Publish permission granted
- SUB: Subscribe permission granted
- DENY: No publish or subscribe permission
CreateTime string Example value: 2022-11-04T07:12:56Z
RocketMQ key creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
Description string Example value: test
Description of the RocketMQ key.
Request example
POST /?Action=DescribeAccessKeys&Version=2023-01-01 HTTP/1.1
Host: rocketmq.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260114T070126Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260114/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"InstanceId": "rocketmq-cnai1f0c29ca****",
"PageNumber": 1,
"PageSize": 10
}
Response example
{
"ResponseMetadata": {
"RequestId": "2026011415270808618823515119****",
"Action": "DescribeAccessKeys",
"Version": "2023-01-01",
"Service": "RocketMQ",
"Region": "cn-beijing"
},
"Result": {
"Total": 1,
"AccessKeysInfo": [
{
"AccessKey": "2QdEgrGc97AL1p38Fq13****",
"AclConfigJson": "{\"topicPerms\":{\"RMQ_SYS_TRACE_TOPIC\":\"PUB\",\"rocketmq123\":\"PUB|SUB\"},\"groupPerms\":{\"GID_test\":\"PUB|SUB\"}}",
"Actived": true,
"AllAuthority": "SUB",
"CreateTime": "2022-11-04T07:12:56Z",
"Description": "test"
}
]
}
}
Error code
The following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.
Last updated: 2026.02.09 11:47:46
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
