文档中心

消息队列 RocketMQ版

密钥管理

CreateAccessKey - 创建 AccessKey 密钥

调用 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 的读写权限。

ALL：拥有发布、订阅权限

PUB：拥有发布权限

SUB：拥有订阅权限

DENY（默认）：不具备发布和订阅权限

Description string 可选示例值：describe

RocketMQ 密钥的描述信息，用于有效区分和管理密钥。长度限制为 0～128 个字符。

创建密钥后，推荐调用 DescribeAccessKeys 接口查看已创建的 RocketMQ 密钥列表，您可以通过Description参数识别出目标密钥。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

AccessKey string 示例值：ZJ7*****************A2gG

RocketMQ 密钥 ID。

SecretKey string 示例值：QW7*****************A2bC

RocketMQ 密钥。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	MissingParameter	The request body is missing a required parameter %s.	缺少%s参数。
400	UnsupportedParameter	The specified parameter %s is unsupported.	不支持%s参数。
400	NotModifiedParameter	The resource was not changed.	未变更任何配置。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
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.	当前实例状态不允许执行该操作。
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.	资源繁忙，可能由于指定资源正在被访问或回收。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

最近更新时间：2026.02.13 18:31:53

这个页面对您有帮助吗？

有用

无用