文档中心
文档
备案
控制台
登录
立即注册
导航
消息队列 RocketMQ版
搜索目录或文档标题
搜索目录或文档标题
产品动态
新功能发布记录
产品公告
消息队列 RocketMQ版正式商用通知
产品简介
什么是消息队列 RocketMQ版
产品优势
应用场景
产品功能
产品规格
相关概念
限制说明
产品计费
计费概述
计费项
计费类型
按量计费
包年包月
转包年包月
实例续费
欠费或到期说明
退订或变配费用说明
税费及发票
快速入门
概述
准备环境
创建资源
生产消费普通消息
用户指南
实例管理
实例生命周期管理
创建实例
升级实例规格
删除实例
查看实例详情
实例连接管理
设置公网访问与 SSL 认证策略
设置公网解析
修改接入点域名前缀
实例运维管理
修改实例 TPS 比例
实例标签管理
标签概述
绑定标签
根据标签筛选实例
编辑和解绑标签
Topic 管理
创建 Topic
批量导入 Topic
导出 Topic 列表
在线发送消息
设置 Topic 密钥权限
设置 Topic 队列数
查看 Topic 消费信息
删除 Topic
Group 管理
创建 Group
批量导入 Group
导出 Group 列表
查看 Group 消费状态
重置消费位点
删除 Group
密钥管理
创建密钥
配置密钥权限
管理密钥
消息查询
消息查询
消息轨迹
死信管理
死信消息概述
死信消息管理
监控告警
查看监控数据
设置告警规则
推荐设置的告警规则
风险巡检
巡检概述
启停风险巡检
巡检规则
风险治理
后台任务管理
查看后台任务
白名单管理
创建白名单
为白名单绑定实例
为白名单解绑实例
查看白名单信息
修改白名单
删除白名单
访问控制
基于 IAM 管理权限
可授权的资源和操作
跨服务访问授权
Terraform
通过 Terraform 管理消息队列 RocketMQ版
API 参考
API 版本说明
V2（2023-01-01）
使用前必读
如何调用 API
请求结构
服务地址
签名机制
返回结果
公共参数
API 概览
资源检查
DescribeRegions - 查询Region
DescribeAvailabilityZones - 查询可用区列表
实例管理
CreateInstance - 创建实例
DescribeInstances - 查询实例列表
DescribeInstanceDetail - 查询实例详情
DeleteInstance - 删除实例
ModifyInstanceAttributes - 修改实例信息元信息
ModifyInstanceSpec - 修改实例配置
ModifyInstanceChargeType - 修改实例计费方式
网络管理
CreatePublicAddress - 开启公网访问
DeletePublicAddress - 关闭公网访问
Topic管理
CreateTopic - 创建topic
DeleteTopic - 删除topic
DescribeTopicAccessPolicies - 查询Topic权限列表
ModifyTopicAccessPolicies - 修改Topic权限
DescribeTopics - 查看Topic列表
DescribeTopicQueue - 查看Topic队列信息
DescribeTopicGroups - 查看Topic下的Group列表
MessageSend - 发送消息
Group管理
CreateGroup - 创建Group
DeleteGroup - 删除Group
DeleteGroups - 批量删除消费组
DescribeGroups - 获取实例Group列表
DescribeGroupsDetail - 查看 Group 详情
DescribeConsumedTopics - 查看 Group 订阅的 Topic
DescribeConsumedTopicDetail - 查询Group消费详情
DescribeConsumedClients - 查看 Group 连接的客户端信息
ResetConsumedOffsets - 重置消费位点
消息查询
QueryMessageByMsgId - 根据消息ID进行消息查询
QueryMessageByMsgKey - 按MessageKey查询消息
QueryMessageByTimestamp - 按时间查询消息
QueryMessageTraceByMessageId - 查询消息轨迹
死信队列
QueryDLQMessageById - 根据MessageID查询Group死信消息
QueryDLQMessageByGroupId - 根据时间范围查询指定 Group 的死信消息
ResendDLQMessageById - 重发指定的死信消息
密钥管理
CreateAccessKey - 创建AccessKey密钥
DescribeSecretKey - 查看AccessKey的SecretKey
DeleteAccessKey - 删除AccessKey
ModifyAccessKeyAllAuthority - 修改AccessKey默认权限
ModifyAccessKeyAuthority - 修改AccessKey自定义权限
DescribeAccessKeys - 查询密钥列表
DescribeAccessKeyDetail - 查询密钥详情
风险巡检
EnableInstanceInspect - 开启或关闭实例的风险巡检功能
GetInspectConfig - 查询巡检规则的相关配置
ManualTriggerInspect - 手动触发巡检
ManualProcessResult - 手动处理巡检结果
GetInstanceInspectResult - 查询实例巡检的异常结果
标签管理
AddTagsToResource - 为实例添加标签
RemoveTagsFromResource - 删除实例的标签
DescribeTagsByResource - 查询实例的标签
白名单管理
CreateAllowList - 创建访问白名单
ModifyAllowList - 修改访问白名单
DeleteAllowList - 删除访问白名单
DescribeAllowLists - 查询访问白名单列表
DescribeAllowListDetail - 查询单个访问白名单详情
AssociateAllowList - 绑定访问白名单至实例
DisassociateAllowList - 从实例上解绑访问白名单
附录
错误码列表
请求幂等性
V1（2021-04-01）
使用前必读
如何调用 API
请求结构
服务地址
签名机制
返回结果
公共参数
API 概览
实例管理
CreateInstance
DeleteInstance
ListInstances
GetInstance
ScaleInstance
EnablePublicNetwork
DisablePublicNetwork
GetEipNum
Topic 管理
CreateTopic
DeleteTopic
ListTopics
GetTopic
消费管理
ResetGroupOffset
Group 管理
CreateGroup
DeleteGroup
ListGroups
GetGroup
死信队列
QueryDLQMessageByMessageId
ExportDLQMessages
密钥管理
CreateAuthKey
DeleteAuthKey
DescribeAuthKey
ListTopicPermissions
GetSk
UpdateAccessKey
DeleteTopicsFromAuthKey
附录
数据结构
SDK 参考
RocketMQ 5.x
概述
参数说明
JAVA 5.x SDK
概述
普通消息
顺序消息
事务消息
延迟消息
GO 5.x SDK
概述
普通消息
顺序消息
事务消息
延迟消息
C++ SDK
概述
普通消息
顺序消息
事务消息
延迟消息
PYTHON SDK
普通消息
顺序消息
事务消息
延迟消息
RocketMQ 4.x
概述
Java SDK
概述
准备工作
普通消息
顺序消息
事务消息
定时消息和延时消息
参数说明
Go SDK
概述
准备工作
普通消息
顺序消息
事务消息
定时消息和延时消息
参数说明
Python SDK
概述
准备工作
普通消息
顺序消息
事务消息
定时消息和延时消息
参数说明
C++ SDK
概述
准备工作
普通消息
顺序消息
事务消息
延时消息
参数说明
RocketMQ 管控面SDK
概述
最佳实践
业务迁移
迁移概述
RocketMQ 业务迁移
RocketMQ 实例更配场景
RocketMQ 生产者使用建议
RocketMQ 消费者使用建议
RocketMQ 客户端使用建议
跨可用区部署 RocketMQ 实例
通过函数服务消费消息队列 RocketMQ 版
RocketMQ 集群扩容实践
常见问题
产品咨询
相关协议
产品和服务测试协议
中间件产品服务专用条款
消息队列服务等级协议（SLA）
文档首页
/
消息队列 RocketMQ版
/
SDK 参考
/
RocketMQ 4.x
/
Go SDK
/
参数说明
参数说明
最近更新时间：2025.07.09 16:22:41
首次发布时间：2022.01.28 15:16:40
我的收藏
有用
有用
无用
无用
文档反馈