消息队列 RocketMQ版
消息队列 RocketMQ版
消息队列 RocketMQ版
文档指南
请输入
产品动态
用户指南
实例管理
后台任务管理
Terraform
RocketMQ Agent
API 参考
实例管理
Topic管理
Group管理
消息查询
死信队列
密钥管理
风险巡检
白名单管理
终端节点服务
SDK 参考
RocketMQ 5.x
RocketMQ 4.x
RocketMQ 管控面SDK
最佳实践
- 文档首页
消息队列 RocketMQ版API 参考白名单管理AssociateAllowList - 绑定访问白名单至实例
复制全文
下载 pdfAssociateAllowList - 绑定访问白名单至实例
文档反馈
问问助手调用 AssociateAllowList 接口绑定实例与白名单。
使用说明
此接口用于为实例绑定白名单，支持批量操作。
注意事项
请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：AssociateAllowList
要执行的操作，取值：AssociateAllowList。
Version string 必选 示例值：2023-01-01
API的版本，取值：2023-01-01。
InstanceIds string[] 必选 示例值：acl-d1d6af207f3d41f69af8bc5136a7****
需要绑定白名单的实例 ID 列表。
AllowListIds string[] 必选 示例值：rocketmq-cnai1f0c29ca****,rocketmq-cnai1f0c29ca****
需要绑定的白名单 ID 列表。
返回参数
请求示例
POST /?Action=AssociateAllowList&Version=2023-01-01 HTTP/1.1
Host: rocketmq.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260115T072501Z
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
{
"InstanceIds": [
"acl-d1d6af207f3d41f69af8bc5136a7****"
],
"AllowListIds": [
"rocketmq-cnai1f0c29ca****",
"rocketmq-cnai1f0c29ca****"
]
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2026011515252824116805621340****",
"Action": "AssociateAllowList",
"Version": "2023-01-01",
"Service": "RocketMQ",
"Region": "cn-beijing"
},
"Result": {}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
状态码 | 错误码 | 错误信息 | 说明 |
200 | OK | OK | 成功。 |
400 | MissingParameter | The request body is missing a required parameter %s. | 缺少%s参数。 |
400 | InvalidParameter | The specified parameter %s is not valid. | 参数值%s无效，请检查后重试。 |
400 | QuotaExceeded.AuthKeyNumber | The number of authKeys exceeds the limit. | 密钥数量超出上限。 |
400 | OperationDenied.InvalidRequest | The request that you specified is not valid. | 请求异常，请检查后重试。 |
400 | UnsupportedParameter | The specified parameter %s is unsupported. | 不支持%s参数。 |
400 | InvalidPara | The specified parameter is not valid. | 参数值无效。 |
403 | OperationDenied_AccountNotAuthorized | You are not authorized to perform this operation. | 您不具备相关权限，请授权或切换账号后重试。 |
403 | OperationDenied.VersionUnsupported | The current instance version does not support this operation.Please upgrade the instance and try again. | 当前实例版本不支持指定操作，请升级实例后再试。 |
403 | OperationDenied.TaskIsRunning | An operation is currently in progress. Try again later. | 后台任务正在运行中，请稍后再试。 |
403 | OperationDenied.InvalidInstanceStatus | The operation is not valid for the current status of the instance. | 当前实例状态不允许执行该操作。 |
403 | OperationDenied.ResourceOccupied | The resource is busy now, please try again later. | 资源繁忙，可能由于指定资源正在被访问或回收。 |
403 | OperationDenied.AccountNotAuthorized | You are not authorized to perform this operation. | 您不具备相关权限，请授权或切换账号后重试。 |
403 | OperationDenied.InternetAccessEnabled | Internet access is enabled for the instance. | 该实例已开启公网访问方式。 |
404 | InvalidAccessKeyId.NotFound | The specified accessKey does not exist. | AccessKey 不存在。 |
404 | InvalidInstanceId.NotFound | The specified Instance ID does not exist. | 实例不存在。 |
500 | InternalError | The request failed due to some unknown error, exception or failure. | 内部错误，请稍后再试。 |
500 | ResourceIsBusy | The resource is busy now, please try again later. | 资源繁忙，可能由于指定资源正在被访问或回收。 |
最近更新时间：2026.02.13 18:31:53
这个页面对您有帮助吗？
有用
有用
无用
无用