云消息队列 RocketMQ 5.0 版_API文档

云消息队列 RocketMQ 5.0 版 - OpenAPI 概览2022-08-01
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
实例
OpenAPI 名称描述操作
CreateInstancehot创建云消息队列 RocketMQ 版5.x系列实例查看文档去调试
UpdateInstancehot更新云消息队列 RocketMQ 版实例的基本信息和规格配置查看文档去调试
DeleteInstance释放实例查看文档去调试
ListInstanceshot查询指定地域下,所有的云消息队列 RocketMQ 版实例的列表信息查看文档去调试
GetInstancehot获取某个指定实例的详细信息查看文档去调试
主题
OpenAPI 名称描述操作
CreateTopichot创建云消息队列 RocketMQ 版的主题(Topic)。主题是云消息队列 RocketMQ 版中消息传输和存储的顶层容器,用于标识同一类业务逻辑的消息。在消息收发模型中,生产者将消息发送至主题,消费者通过订阅指定的主题来消费其中的消息查看文档去调试
UpdateTopic更新主题的备注信息查看文档去调试
DeleteTopic删除指定主题查看文档去调试
ListTopicshot查询指定实例下的主题列表信息查看文档去调试
GetTopichot获取某个指定主题的详细信息查看文档去调试
消费者分组
OpenAPI 名称描述操作
CreateConsumerGrouphot创建云消息队列 RocketMQ 版的消费者分组(ConsumerGroup)。消费者分组是云消息队列 RocketMQ 版系统中承载多个消费行为一致的消费者的负载均衡分组。消费者需要通过指定消费者分组订阅相关的主题来实现消息订阅查看文档去调试
UpdateConsumerGroup更新消费者分组的基础信息和消费重试策略查看文档去调试
DeleteConsumerGroup删除指定的消费者分组查看文档去调试
ListConsumerGroupshot查询指定实例下消费者分组的列表信息查看文档去调试
GetConsumerGrouphot获取某个指定消费者分组的详细信息查看文档去调试
订阅关系
OpenAPI 名称描述操作
ListTopicSubscriptions查询主题订阅关系列表查看文档去调试
ListConsumerGroupSubscriptions查询消费组订阅关系列表查看文档去调试
GetConsumerGroupSubscription获取消费组订阅关系详情,包括客户端分布等信息查看文档去调试
DeleteConsumerGroupSubscription删除消费者组订阅关系查看文档去调试
消费
OpenAPI 名称描述操作
ListConsumerConnections获取指定消费者客户端的连接信息查看文档去调试
GetConsumerGroupLag查询消费者组堆积信息查看文档去调试
GetConsumerStack获取消费者堆栈信息查看文档去调试
ResetConsumeOffset重置指定消费者分组的消费位点。重置消费位点是指改变订阅者当前的消费位置。当消费者出现故障或者消费错误数据时,您可通过重置消费位点将消费位置回滚到之前的某个位点重新开始消费,您也可以将消费位置移动至最新位点,暂时不处理堆积的消息查看文档去调试
消息
OpenAPI 名称描述操作
ListMessages查询消息列表查看文档去调试
GetMessageDetail获取指定消息的详情查看文档去调试
VerifySendMessage验证指定实例下指定主题的消息发送功能查看文档去调试
VerifyConsumeMessage验证指定实例下指定主题的消息消费状态查看文档去调试
轨迹
OpenAPI 名称描述操作
ListTraces查询指定主题下的轨迹消息列表查看文档去调试
GetTrace获取指定主题下的指定消息轨迹查看文档去调试
ACL
OpenAPI 名称描述操作
CreateInstanceAccount创建实例的访问账号查看文档去调试
UpdateInstanceAccount更新指定实例下指定账号的信息查看文档去调试
DeleteInstanceAccount删除指定实例下的访问账号信息查看文档去调试
ListInstanceAccount查询指定实例下访问账号的列表查看文档去调试
GetInstanceAccount获取指定实例的账号查看文档去调试
CreateInstanceAcl在指定实例下创建访问的权限信息查看文档去调试
UpdateInstanceAcl更新指定实例下,指定用户和资源的访问权限查看文档去调试
DeleteInstanceAcl删除指定实例下,指定账号和资源的权限查看文档去调试
ListInstanceAcl查询指定实例下的访问权限列表查看文档去调试
GetInstanceAcl查询访问权限信息详情查看文档去调试
CreateInstanceIpWhitelist创建访问控制IP白名单查看文档去调试
DeleteInstanceIpWhitelist删除指定实例下的指定全局IP白名单查看文档去调试
ListInstanceIpWhitelist查询访问控制IP白名单列表查看文档去调试
GetInstanceIpWhitelist查询访问控制IP白名单详情查看文档去调试
Global Replicator
OpenAPI 名称描述操作
CreateDisasterRecoveryPlan创建备份计划查看文档去调试
DeleteDisasterRecoveryPlan删除备份计划查看文档去调试
UpdateDisasterRecoveryPlan修改备份计划查看文档去调试
ListDisasterRecoveryPlans查询备份计划列表查看文档去调试
GetDisasterRecoveryPlan查询备份计划详情查看文档去调试
AddDisasterRecoveryItem添加备份映射任务查看文档去调试
UpdateDisasterRecoveryItem更新备份映射任务查看文档去调试
DeleteDisasterRecoveryItem删除备份映射任务查看文档去调试
StartDisasterRecoveryItem启用备份映射任务查看文档去调试
StopDisasterRecoveryItem停用备份映射任务查看文档去调试
ListDisasterRecoveryItems查询备份映射任务列表查看文档去调试
GetDisasterRecoveryItem查询备份计划映射详情查看文档去调试
ListDisasterRecoveryCheckpoints查询消费进度同步列表查看文档去调试
SyncDisasterRecoveryCheckpoint同步消费进度信息到目标实例查看文档去调试
标签
OpenAPI 名称描述操作
ListTagResources查询可见的资源标签关系查看文档去调试
TagResources用户创建标签资源关系查看文档去调试
UntagResources用户删除标签资源关系查看文档去调试
资源组
OpenAPI 名称描述操作
ChangeResourceGroup修改实例所属的资源组查看文档去调试
其他
OpenAPI 名称描述操作
ListRegions查询地域列表查看文档去调试
ListAvailableZones查询支持的可用区查看文档去调试
ListMetricMeta查询监控项列表查看文档去调试