CreateAccessKey - 创建AccessKey密钥--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

CreateAccessKey - 创建AccessKey密钥

最近更新时间：2024.11.18 10:27:31首次发布时间：2023.07.12 16:22:34

调用 CreateAccessKey 创建 RocketMQ 密钥。

使用说明

火山引擎消息队列 RocketMQ版通过密钥管理 Topic 权限，密钥由 AccessKey ID 与对应的 AccessKey Secret 组成，用于访问实例、生产消费时的鉴权与身份认证。此接口用于创建密钥。

说明

所有 RocketMQ 实例默认开启 ACL 访问控制，无需手动开启或关闭。
创建密钥后，密钥默认为已启用状态。若不再使用此密钥，建议及时删除密钥。
每个实例中最多可创建 100 个密钥。

注意事项

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateAccessKey	要执行的操作，取值：CreateAccessKey。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
AllAuthority	String	是	Deny	此 RocketMQ 密钥是否默认具备所有 Topic 的读写权限。默认值为 Deny。 ALL：拥有发布、订阅权限 PUB：拥有发布权限 SUB：拥有订阅权限 DENY：不具备发布和订阅权限
Description	String	否	describe	RocketMQ 密钥的描述信息，用于有效区分和管理密钥。长度限制为 0～128 个字符。创建密钥后，推荐调用 DescribeAccessKeys 接口查看已创建的 RocketMQ 密钥列表，您可以通过 Description 参数识别出目标密钥。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

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

{
  "InstanceId": "rocketmq-cnai1f0c29ca****",
  "Description": "test",
  "AllAuthority": "ALL"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023050819321711C83A4A91A1F748D292",
        "Action": "CreateAccessKey",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {}
}

错误码

公共错误码请参见公共错误码文档。