检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 实例管理类接口 API 说明 生命周期管理 包括创建实例、修改实例信息、查询实例、删除实例、查询代理列表。 消费组管理 包括查询消费组、创建消费组、删除消费组、修改消费组、查询消费列表或详情、重置消费进度。 Topic管理 包括创建主题、删除主题、查询主题、修改
如何调用API 构造请求 认证鉴权 返回结果
其他接口 查询可用区信息 父主题: API V2(推荐)
查询可用区信息 功能介绍 在创建实例时,需要配置实例所在的可用区ID,可通过该接口查询可用区的ID。 调用方法 请参见如何调用API。 URI GET /v2/available-zones 请求参数 无 响应参数 状态码: 200 表1 响应Body参数 参数 参数类型 描述 region_id
API V2(推荐) 生命周期管理 消费组管理 Topic管理 消息管理 用户管理 元数据迁移 参数管理 标签管理 其他接口 规格变更管理
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数
n鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 云
Topic管理 创建主题或批量删除主题 查询主题列表 删除指定主题 查询单个主题 修改主题 查询主题消费组列表 查询主题的消息数 父主题: API V2(推荐)
用户管理 创建用户 查询用户列表 修改用户参数 查询用户详情 删除用户 查询主题的授权用户列表 查询消费组的授权用户列表 父主题: API V2(推荐)
参数管理 查询RocketMQ配置 修改RocketMQ配置 父主题: API V2(推荐)
查询RocketMQ配置 功能介绍 该接口用于查询RocketMQ配置,若成功则返回配置的相关信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rocketmq/instances/{instance_id}/configs 表1 路径参数
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头
创建消费组或批量删除消费组 批量修改消费组 删除指定消费组 查询指定消费组 修改消费组 查询消费列表或详情 重置消费进度 查询消费者列表 父主题: API V2(推荐)
修改RocketMQ配置 功能介绍 该接口用于修改RocketMQ配置。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/rocketmq/instances/{instance_id}/configs 表1 路径参数 参数 是否必选 参数类型
查询消息 功能介绍 查询消息。 调用方法 请参见如何调用API。 URI GET /v2/{engine}/{project_id}/instances/{instance_id}/messages 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 消息引擎。
删除指定主题 功能介绍 删除指定主题。 调用方法 请参见如何调用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 V2(推荐)
修改主题 功能介绍 修改主题。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/instances/{instance_id}/topics/{topic} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String