Message Queue for RabbitMQ
Message Queue for RabbitMQ
Document
- Documentation
Message Queue for RabbitMQAPI referenceV2（2022-01-01）Allowlist 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.
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
The action to be executed: CreateAllowList.
Version string required Example value: 2022-01-01
API version, value: 2022-01-01.
AllowListName string required Example value: testlist
Allowlist name, with the following restrictions:
- Length must be between 1 and 128 characters.
- Only Chinese characters, letters, numbers, underscores, or hyphens (-) are allowed.
- Cannot start with a number or a hyphen (-).
- The allowlist name must be unique within the current region.
AllowList string required Example value: ["127.0.0.1"]
List of IP addresses that are allowed to access.
- Separate multiple IP addresses with English commas (,); do not repeat addresses.
- Supported formats:
- IP address format, such as 10.23.12.xx.
- CIDR format, such as 10.23.12.x/xx.
- When there are many IPs, it is recommended to combine them into an IP range, such as 10.23.12.x/24.
- You can add up to 300 IP addresses or IP ranges in each instance. This is the total sum of all IPs or IP ranges in all allowlist groups.
AllowListDesc string Optional Example value: forTest
A description of the allowlist. The total length must not exceed 200 characters.
AllowListType string required Example value: IPv4
IP address type; currently, only IPv4 is 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****
Successfully created allowlist ID.
Request example
POST /?Action=CreateAllowList&Version=2022-01-01 HTTP/1.1
Host: rabbitmq.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260107T101939Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260107/cn-beijing/RabbitMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"AllowListName": "testlist",
"AllowList": "[\"127.0.0.1\"]",
"AllowListType": "IPv4"
}
Response example
{
"ResponseMetadata": {
"RequestId": "2026010718195122721009325313****",
"Action": "CreateAllowList",
"Version": "2022-01-01",
"Service": "RabbitMQ",
"Region": "cn-beijing"
},
"Result": {
"AllowListId": "acl-d1d6af207f3d41f69af8bc5136a7****"
}
}
Error code
Error codesThe 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.06 14:27:45
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
