检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 实例管理类接口 API 说明 生命周期管理 包括创建实例、修改实例信息、查询实例、删除实例、查询代理列表。 消费组管理 包括查询消费组、创建消费组、删除消费组、修改消费组、查询消费列表或详情、重置消费进度。 Topic管理 包括创建主题、删除主题、查询主题、修改
如何调用API 构造请求 认证鉴权 返回结果
其他接口 查询可用区信息 父主题： API V2（推荐）
API V2（推荐） 生命周期管理 消费组管理 Topic管理 消息管理 用户管理 元数据迁移 参数管理 标签管理 其他接口 规格变更管理
查询可用区信息 功能介绍 在创建实例时，需要配置实例所在的可用区ID，可通过该接口查询可用区的ID。 调用方法 请参见如何调用API。 URI GET /v2/available-zones 请求参数 无 响应参数 状态码： 200 表1 响应Body参数 参数 参数类型 描述 region_id
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数
账号具备所有接口的调用权限，如果使用账号下的IAM用户发起API请求时，该IAM用户必须具备调用该接口所需的权限，否则，API请求将调用失败。每个接口所需要的权限，与各个接口所对应的授权项相对应，只有发起请求的用户被授予授权项所对应的策略，该用户才能成功调用该接口。例如，用户要
返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请
有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式：项目级服务和全局级服务。其中： 项目级服务需要获取项目级别的Token，此时请求body中auth
查询RocketMQ配置 功能介绍 该接口用于查询RocketMQ配置，若成功则返回配置的相关信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rocketmq/instances/{instance_id}/configs 表1 路径参数
本文档提供了分布式消息服务RocketMQ版API的描述、语法、参数说明及样例等内容。 分布式消息服务RocketMQ版持续增加新的功能，将不可避免对现有接口有所调整，比如增加响应参数。 为了减少接口变更带来的影响，除了分布式消息服务RocketMQ版自身尽量做到接口向下兼容的同时，用户在使用过
获取账号名和账号ID 在调用接口的时候，部分URL中需要填入账号名和账号ID，所以需要先在管理控制台上获取到账号名和账号ID。账号名和账号ID获取步骤如下： 登录管理控制台。 鼠标悬停在右上角的用户名，选择下拉列表中的“我的凭证”。 查看账号名和账号ID。 图1 查看账号名和账号ID
修改RocketMQ配置 功能介绍 该接口用于修改RocketMQ配置。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/rocketmq/instances/{instance_id}/configs 表1 路径参数 参数 是否必选 参数类型
创建实例 功能介绍 创建实例，该接口支持创建按需和包周期两种计费方式的实例。 调用方法 请参见如何调用API。 URI POST /v2/{engine}/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String
创建用户 功能介绍 创建用户。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/instances/{instance_id}/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。
导出死信消息 功能介绍 导出死信消息。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/instances/{instance_id}/messages/export 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询主题列表 功能介绍 该接口用于查询指定RocketMQ实例的Topic列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id}/topics 表1 路径参数 参数 是否必选 参数类型 描述 project_id
修改实例信息 功能介绍 修改实例的名称和描述信息。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。
获取项目ID 操作场景 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。有如下两种获取方式： 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https:
修改用户参数 功能介绍 修改用户参数。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/instances/{instance_id}/users/{user_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
