Message Queue for RocketMQ
Message Queue for RocketMQ
Document
- Documentation
Message Queue for RocketMQAPI ReferenceAllowlist managementCreateAllowList - Create access allowlist
Copy page
Download PDFAllowlist management
CreateAllowList - Create access allowlist
Copy pageDownload PDFCreateAllowList - Create access allowlist
Call CreateAllowList to create a new IP allowlist rule.
Instructions
After you create an allowlist and bind it to a RocketMQ instance, only the IP addresses or ranges configured in the allowlist can access the instance. Each VolcanoEngine account can create up to 100 RocketMQ allowlists per region.
Note
Request frequency: This API limits requests to 100 times per second; the per-user request frequency limit is 20 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: CreateAllowList
Operation to be performed. Value: CreateAllowList.
Version string requiredExample: 2023-01-01
API version: 2023-01-01.
AllowListName string required Example: testlist
Allowlist name.
- Must be 1 to 128 characters long.
- Only Chinese characters, letters, numbers, underscores, and hyphens (-) are allowed.
- Cannot start with a number or hyphen (-).
- The allowlist name must be unique within the current region.
AllowList string required Example: 127.0.0.1
IP address list. These IP addresses are allowed access.
- Separate multiple IP addresses with commas (,). Duplicates are not allowed.
- Supports IP address format (for example, 10.23.12.xx) and CIDR format (for example, 10.23.12.x/xx).
- When there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.x/24.
- Each instance can add up to 300 IPs or IP ranges. The total number of IPs or IP ranges across all allowlist groups must not exceed 300.
AllowListDesc string Optional Example value: forTest
Allowlist description. Length must not exceed 200 characters.
AllowListType string required Example value: IPv4
IP address type. Only IPv4 is currently supported.
Response parameters
Only the unique response parameters of this API are listed below. For more details, see response structure.
AllowListId string Example value: acl-d1d6af207f3d41f69af8bc5136a7****
Allowlist ID created successfully.
Request example
POST /?Action=CreateAllowList&Version=2023-01-01 HTTP/1.1
Host: rocketmq.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260115T063651Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260115/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"AllowListName": "testlist",
"AllowList": "127.0.0.1",
"AllowListType": "IPv4"
}
Response example
{
"ResponseMetadata": {
"RequestId": "20260115143655174055079105BA****",
"Action": "CreateAllowList",
"Version": "2023-01-01",
"Service": "RocketMQ",
"Region": "cn-beijing"
},
"Result": {
"AllowListId": "acl-d1d6af207f3d41f69af8bc5136a7****"
}
}
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
