Message Queue for RabbitMQ
Message Queue for RabbitMQ
Document
- Documentation
Message Queue for RabbitMQAPI referenceV2（2022-01-01）Allowlist managementModifyAllowList - Edit access allowlist
Copy page
Download PDFAllowlist management
ModifyAllowList - Edit access allowlist
Copy pageDownload PDFModifyAllowList - Edit access allowlist
Call the ModifyAllowList API to modify an existing 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: ModifyAllowList
Operation to perform: ModifyAllowList.
Version string required Example value: 2022-01-01
API version, value: 2022-01-01.
AllowListId string required Example value: acl-d1d6af207f3d41f69af8bc5136a7****
ID of the allowlist to be modified.
AllowList string Optional Example value: ["127.0.0.1"]
List of IP addresses that are allowed to access the service.
- Separate multiple IP addresses with commas (,) and avoid duplicates.
- Supported formats:
- IP address format, for example: 10.23.12.xx.
- CIDR format, for example: 10.23.12.xx/xx.
- If there are many IPs, it is recommended to use IP ranges, such as 10.23.12.x/24.
- You can add up to 300 IP addresses or ranges for each instance—the total number of IPs or ranges across all allowlist groups must not exceed 300.
AllowListName string required Example: testlist
Allowlist name constraints:
- Length must be between 1 and 128 characters.
- Only Chinese characters, letters, numbers, underscores, or hyphens (-) are allowed.
- Cannot start with a number or hyphen (-).
- The allowlist name must be unique within the current region.
AllowListDesc string Optional Example: for-test
Description of the modified allowlist. Length must not exceed 200 characters. The default value is empty. If not set during modification, the description will be set to an empty string.
ModifyMode string Optional Example value: Cover
Allowlist modification mode. The default is Cover. Supports the following settings:
- Cover: Use the value of the AllowList parameter to replace the original allowlist.
- Append: Add the IP addresses specified in the AllowList parameter to the original allowlist.
- Delete: Remove the IP addresses specified in the AllowList parameter from the original allowlist. At least one IP address must be retained.
ApplyDBInstanceNum integer required Example: 1
Number of applied instances, which is the current number of instances bound to this allowlist. The main purpose is to confirm the impact of this modification and prevent failures caused by incorrect operations.
Response parameters
This interface has no unique response parameters. For more information, see the response structure.
Request example
POST /?Action=ModifyAllowList&Version=2022-01-01 HTTP/1.1
Host: rabbitmq.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260107T102309Z
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
{
"AllowListId": "acl-d1d6af207f3d41f69af8bc5136a7****",
"AllowListName": "testlist",
"ApplyDBInstanceNum": 1
}
Response example
{
"ResponseMetadata": {
"RequestId": "2026010718231413606904406199****",
"Action": "ModifyAllowList",
"Version": "2022-01-01",
"Service": "RabbitMQ",
"Region": "cn-beijing"
},
"Result": {}
}
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
