检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
本文档提供了分布式消息服务RocketMQ版API的描述、语法、参数说明及样例等内容。 分布式消息服务RocketMQ版持续增加新的功能，将不可避免对现有接口有所调整，比如增加响应参数。 为了减少接口变更带来的影响，除了分布式消息服务RocketMQ版自身尽量做到接口向下兼容
删除用户 功能介绍 删除用户。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/instances/{instance_id}/users/{user_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
数据迁移任务接口。 2023-04-21 本次变更如下： 新增查询消费者列表接口。 2023-02-17 本次变更如下： 更新创建实例的URI。 新增批量添加或删除实例标签、查询实例标签和查询项目标签接口。 2023-01-13 本次变更如下： 新增查询主题列表接口。 2022-07-07
查询消息 功能介绍 查询消息。 调用方法 请参见如何调用API。 URI GET /v2/{engine}/{project_id}/instances/{instance_id}/messages 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 消息引擎。
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 对于管理员创建IAM用户接口，返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头
修改主题 功能介绍 修改主题。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/instances/{instance_id}/topics/{topic} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询实例标签 功能介绍 查询实例标签。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rocketmq/{instance_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。
查询RocketMQ配置 功能介绍 该接口用于查询RocketMQ配置，若成功则返回配置的相关信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rocketmq/instances/{instance_id}/configs 表1 路径参数
删除指定主题 功能介绍 删除指定主题。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/instances/{instance_id}/topics/{topic} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
查询单个主题 功能介绍 查询单个主题。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id}/topics/{topic} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询用户详情 功能介绍 查询用户详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id}/users/{user_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
重启指定实例 功能介绍 重启指定实例。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/{engine}/instances/{instance_id}/restart 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
实例状态说明 表1 实例状态说明 状态 说明 CREATING 申请实例后，在实例状态进入运行中之前的状态。 RUNNING 实例正常运行状态。在这个状态的实例可以运行您的业务。 ERROR 实例处于故障的状态。 RESTARTING 实例正在进行重启操作。 STARTING 实例从已冻结到运行中的中间状态。
修改RocketMQ配置 功能介绍 该接口用于修改RocketMQ配置。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/rocketmq/instances/{instance_id}/configs 表1 路径参数 参数 是否必选 参数类型
查询实例节点 功能介绍 查询实例节点信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/{engine}/instances/{instance_id}/nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
修改消费组 功能介绍 修改指定消费组参数。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/instances/{instance_id}/groups/{group} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
重置消费进度 功能介绍 重置消费进度。 调用方法 请参见如何调用API。 URI POST /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset 表1 路径参数
查询用户列表 功能介绍 查询用户列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id}/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。
删除指定消费组 功能介绍 删除指定消费组。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/instances/{instance_id}/groups/{group} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
消费验证 功能介绍 消费验证。 调用方法 请参见如何调用API。 URI POST /v2/{engine}/{project_id}/instances/{instance_id}/messages/resend 表1 路径参数 参数 是否必选 参数类型 描述 engine 是
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
