文档中心

消息队列 RocketMQ版

API 参考

API 概览

API 概览

消息队列 RocketMQ版提供以下相关 API 接口。

资源检查

API	说明
DescribeRegions	调用 DescribeRegions 接口，查看 Region 列表。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口，查看可用区列表。

实例管理

API	说明
CreateInstance	调用 CreateInstance 接口，创建消息队列 RocketMQ版实例。
DescribeInstances	调用 DescribeInstances 接口，获取当前账户下的实例列表。
DescribeInstanceDetail	调用 DescribeInstanceDetail 接口，查看指定实例的详情。
DeleteInstance	调用 DeleteInstance 接口，释放按量付费实例。
ModifyInstanceAttributes	调用 ModifyInstanceAttributes 接口，修改对应实例名称、描述等实例信息。
ModifyInstanceSpec	调用 ModifyInstanceSpec 接口，修改实例的计算规格、存储规格、增配分区数等产品规格。
ModifyInstanceChargeType	调用 ModifyInstanceChargeType 接口，修改实例的计费方式。
EnableInstanceBurstTps	调用 EnableInstanceBurstTps 接口，开启或者关闭实例弹性 TPS 能力。
EnableAutoCreateGroup	调用 EnableAutoCreateGroup 接口，开启或者关闭实例自动创建 Group 能力。

网络管理

API	说明
CreatePublicAddress	调用 CreatePublicAddress 接口，开启实例的公网访问。
DeletePublicAddress	调用 DeletePublicAddress 接口，关闭实例的公网访问。

Topic 管理

API	说明
CreateTopic	用 CreateTopic 接口，创建 Topic。
DeleteTopic	调用 DeleteTopic 接口，删除 Topic。
DescribeTopicAccessPolicies	调用 DescribeTopicAccessPolicies 接口，查看 Topic 的权限列表。
ModifyTopicAccessPolicies	调用 ModifyTopicAccessPolicies 接口，设置 Topic 的权限策略。
DescribeTopicDetail	调用 DescribeTopicDetail 接口，查询 Topic 详情。
DescribeTopics	调用 DescribeTopics 接口，查看 Topic 列表。
DescribeTopicQueue	调用 DescribeTopicQueue 接口，获取 Topic 的队列信息。
DescribeTopicGroups	调用 DescribeTopiGroups 接口，获取 Topic 的 Group 信息。
MessageSend	调用 MessageSend 接口，向指定 Topic 发送普通消息，验证消息发送链路是否通畅。
CreateTopicAsync	调用 CreateTopicAsync 接口，异步创建 Topic。
DeleteTopicAsync	调用 DeleteTopicAsync 接口，异步删除 Topic。
ModifyTopicDescription	调用 ModifyTopicDescription 接口，修改 Topic 描述。
DescribeProducers	调用 DescribeProducers 接口，查询实例或 Topic 的生产者连接情况。

Group 管理

API	说明
CreateGroup	调用 CreateGroup 接口，创建一个新的消费组（Group）。
DeleteGroup	调用 DeleteGroup 接口，删除消费组（Group）。
DeleteGroups	调用 DeleteGroups 接口，批量删除消费组（Group）。
DescribeGroups	调用 DescribeGroups 接口，获取消费组列表。
DescribeGroupsDetail	调用 DescribeGroupsDetail 接口，查看指定 Group 的详细信息。
DescribeConsumedTopics	调用 DescribeConsumedTopics 接口，查看 Group 订阅的 Topic 信息。
DescribeConsumedTopicDetail	调用 DescribeConsumedTopics 接口，查看 Group 消费 Topic 的进度。
DescribeConsumedClients	调用 DescribeConsumedClients 接口，查看 Group 连接的客户端信息。
ResetConsumedOffsets	调用 ResetConsumedOffsets 接口，重置消费者组消费的消费位点。
CreateGroupAsync	调用 CreateGroupAsync 接口，异步创建 Group。
DeleteGroupAsync	调用 DeleteGroupAsync 接口，异步删除 Group。
UpdateGroup	调用 UpdateGroup 接口，编辑 Group。
DescribeConsumerGroupLag	调用 DescribeConsumerGroupLag 接口，查询 Group 消费堆积详情。
DeleteConsumerGroupSubscription	调用 DeleteConsumerGroupSubscription 接口，删除指定消费组下某个 Topic 的订阅关系。

消息查询

API	说明
QueryMessageByMsgId	调用 QueryMessageByMsgId 接口，查询 Topic 中指定 MessageId 的消息元数据。
QueryMessageByMsgKey	调用 QueryMessageByMsgKey 接口，查询 Topic 中指定 MessageKey 的消息元数据。
QueryMessageByTimestamp	调用 QueryMessageByTimestamp 接口，查询分区中指定时间范围内的消息元数据。
QueryMessageTraceByMessageId	调用 QueryMessageTraceByMessageId 接口，查询消息轨迹。

死信队列管理

API	说明
QueryDLQMessageById	调用 QueryDLQMessageById 接口，查询指定 MessageID 的死信消息。
QueryDLQMessageByGroupId	调用 QueryDLQMessageByGroupId 接口，根据时间范围查询指定 Group 的死信消息。
ResendDLQMessageById	调用 ResendDLQMessageById 接口，重新发送指定 MessageID 的死信消息。

密钥管理

API	说明
CreateAccessKey	调用 CreateAccessKey 接口，创建 RocketMQ 密钥。
DescribeSecretKey	调用 DescribeSecretKey 接口，查看指定 RocketMQ 密钥的 AccessKey Secret。
DeleteAccessKey	调用 DeleteAccessKey 接口，删除 RocketMQ 密钥。
ModifyAccessKeyAllAuthority	调用 ModifyAccessKeyAllAuthority 接口，修改 RocketMQ 密钥的默认权限。
ModifyAccessKeyAuthority	调用 ModifyAccessKeyAuthority 接口，设置 RocketMQ 密钥的自定义权限。
DescribeAccessKeys	调用 DescribeAccessKeys 接口，查询 RocketMQ 密钥列表。
DescribeAccessKeyDetail	调用 DescribeAccessKeyDetail 接口，查询指定 RocketMQ 密钥的详细信息。

风险巡检

API	说明
EnableInstanceInspect	调用 EnableInstanceInspect 接口，开启或关闭实例的风险巡检功能。
GetInspectConfig	调用 GetInspectConfig 接口，查询巡检规则的相关配置。
ManualTriggerInspect	调用 ManualTriggerInspect 接口，手动触发实例的某个巡检规则。
ManualProcessResult	调用 ManualProcessResult 接口，手动处理实例某个巡检异常结果，即将某个异常结果的状态设置为已处理（Solved）状态。
GetInstanceInspectResult	调用 GetInstanceInspectResult 接口，查询实例巡检的异常结果。

白名单管理

API	说明
CreateAllowList	调用 CreateAllowList 接口，创建一个新的 IP 白名单规则。
ModifyAllowList	调用 ModifyAllowList 接口，修改一个已经创建的白名单规则。
DeleteAllowList	调用 DeleteAllowList 接口，删除一个已经创建的白名单规则。
DescribeAllowLists	调用 DescribeAllowLists 接口，查询白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口，查询指定白名单的详细信息。
AssociateAllowList	调用 AssociateAllowList 接口，绑定实例与白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口，解绑实例与白名单。

标签管理

API	说明
AddTagsToResource	调用 AddTagsToResource 接口，为指定实例绑定标签。
RemoveTagsFromResource	调用 RemoveTagsFromResource 接口，为一个或多个实例解绑标签。
DescribeTagsByResource	调用 DescribeTagsByResource 接口，查询已绑定标签的资源。

终端节点服务

API	说明
AddPLWhitelist	调用 AddPLWhitelist 接口，新增终端节点服务白名单。
CreatePrivateLink	调用 CreatePrivateLink 接口，创建私网连接终端节点服务。
DeletePrivateLink	调用 DeletePrivateLink 接口，删除私网连接终端节点服务。
RemovePLWhitelist	调用 RemovePLWhitelist 接口，删除终端节点服务白名单。
DescribePLWhitelist	调用 DescribePLWhitelist 接口，查询终端节点服务白名单。

最近更新时间：2026.08.19 16:06:10

这个页面对您有帮助吗？

有用

有用

无用

无用