CreateAuthKey--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

CreateAuthKey

最近更新时间：2024.03.06 16:49:21首次发布时间：2021.08.30 16:57:44

调用 CreateAuthKey 接口创建 RocketMQ 密钥。

注意事项

请求频率：该接口请求频率限制为 10 次/秒；单用户请求频率限制为 2 次/秒。

使用说明

消息队列 RocketMQ版支持开源 ACL 权限控制，通过密钥提供 Topic 资源级别的访问控制与权限管理，不同的密钥具备不同的 Topic 访问权限。密钥由 AccessKey ID 与对应的 AccessKey Secret 组成。
目前每个实例最多可创建 100 个密钥。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	MQ_INST_********	实例 ID。
TopicDefaultPermission	String	可选	DENY	密钥的默认权限。 DENY：不具备发布或订阅权限。 PUB：（默认）仅具备发布权限，不具备订阅权限。 SUB：仅具备订阅权限，不具备发布权限。 ALL：同时具备发布和订阅权限。
Description	String	可选	newauthkey	密钥的简单描述。长度为 0~128 个字符。

参数

参数类型

是否必选

示例值

说明

InstanceId

String

必选

MQ_INST_********

实例 ID。

TopicDefaultPermission

String

可选

DENY

密钥的默认权限。

DENY：不具备发布或订阅权限。
PUB：（默认）仅具备发布权限，不具备订阅权限。
SUB：仅具备订阅权限，不具备发布权限。
ALL：同时具备发布和订阅权限。

Description

String

可选

newauthkey

密钥的简单描述。长度为 0~128 个字符。

响应参数

参数	参数类型	说明
InstanceId	String	实例 ID。
Ak	String	新密钥的 AccessKey ID。

示例

请求示例

POST https://rocketmq.volcengineapi.com/?Action=CreateAuthKey&Version=2021-04-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK*********************/20210328/cn-beijing/rocketmq/request, SignedHeaders=x-date, Signature=*********************

{
  "InstanceId": "MQ_INST_********",
  "Description": "newauthkey",
  "TopicDefaultPermission": "DENY"
}

响应示例

{
   "ResponseMetadata": {
      "RequestId": "*********************",
      "Action": "CreateAuthKey",
      "Version": "2021-04-01",
      "Service": "rocketmq",
      "Region": "cn-beijing"
   },
   "Result": {
      "Ak": "q70s5SrCgsePZPh3fb0d****",
      "InstanceId": "MQ_INST_72f5d4wtmoyx_d****"
   }