更新时间:2025-06-20 GMT+08:00
分享

API概览

表1 实例管理类接口

API

说明

生命周期管理

包括

  • 查询所有实例列表
  • 创建实例
  • 查询指定实例
  • 删除指定的实例
  • 修改实例信息
  • 批量删除实例
  • 查询代理列表
  • 开启RocketMQ实例域名访问能力

消费组管理

包括:

  • 查询消费组列表
  • 创建消费组或批量删除消费组
  • 批量修改消费组
  • 删除指定消费组
  • 查询指定消费组
  • 修改消费组
  • 查询消费列表或详情
  • 重置消费进度
  • 查询消费者列表

Topic管理

包括:

  • 创建主题或批量删除主题
  • 查询主题列表
  • 删除指定主题
  • 查询单个主题
  • 修改主题
  • 查询主题消费组列表
  • 查询主题的消息数

消息管理

包括:

  • 查询消息
  • 发送消息
  • 查询消息轨迹
  • 导出死信消息
  • 重发死信消息
  • 消费验证

用户管理

包括:

  • 创建用户
  • 查询用户列表
  • 修改用户参数
  • 查询用户详情
  • 删除用户
  • 查询主题的授权用户列表
  • 查询消费组的授权用户列表

元数据迁移

包括:

  • 新建元数据迁移任务
  • 查询实例下所有迁移任务或查询指定迁移任务信息
  • 删除元数据迁移任务

参数管理

包括:

  • 查询RocketMQ配置
  • 修改RocketMQ配置

标签管理

包括:

  • 批量添加或删除实例标签
  • 查询实例标签
  • 查询项目标签

实例诊断

包括:

  • 创建实例诊断任务
  • 查询实例诊断列表
  • 批量删除实例诊断记录
  • 查询实例诊断报告
  • 查询stack信息

规格变更管理

包括:

  • 查询实例的扩容规格列表
  • 实例规格变更

实例管理

包括:

  • 查询实例节点
  • 重启指定实例
  • 修改实例ssl相关配置

后台任务管理

包括:

  • 查询后台任务管理中的指定记录
  • 删除后台任务管理中的指定记录
  • 查询实例的后台任务列表

其他接口

包括:

  • 查询可用区信息
  • 查询产品规格列表
  • 查询RocketMQ产品规格核数

相关文档