检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式:项目级服务和全局级服务。其中: 项目级服务需要获取项目级别的Token,此时请求body中auth
API概览 表1 实例管理类接口 API 说明 生命周期管理 包括创建实例、修改实例信息、查询实例、删除实例、查询代理列表。 消费组管理 包括查询消费组、创建消费组、删除消费组、修改消费组、查询消费列表或详情、重置消费进度。 Topic管理 包括创建主题、删除主题、查询主题、修改
如何调用API 构造请求 认证鉴权 返回结果
API V2(推荐) 生命周期管理 消费组管理 Topic管理 消息管理 用户管理 元数据迁移 参数管理 标签管理 其他接口 规格变更管理
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET ht
如果是专属云场景采用AK/SK认证方式的接口请求,或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。
获取账号名和账号ID 在调用接口的时候,部分URL中需要填入账号名和账号ID,所以需要先在管理控制台上获取到账号名和账号ID。账号名和账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”。 查看账号名和账号ID。 图1 查看账号名和账号ID
路径参数 参数 是否必选 参数类型 描述 engine 是 String 消息引擎。 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 group_id 是 String 消费组。 表2 Query参数
消息引擎。 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 topic 是 String 主题名称。 limit 否 String 查询数量。
请参见如何调用API。 URI DELETE /v2/{project_id}/instances/{instance_id}/topics/{topic} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
请参见如何调用API。 URI DELETE /v2/{project_id}/instances/{instance_id}/users/{user_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
查询RocketMQ配置 功能介绍 该接口用于查询RocketMQ配置,若成功则返回配置的相关信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rocketmq/instances/{instance_id}/configs 表1 路径参数
请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id}/topics/{topic} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id
参数类型 描述 engine 是 String 引擎类型:reliability。 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 group_id 是 String 消费组名称。 请求参数 表2 请求Body参数
请参见如何调用API。 URI PUT /v2/{project_id}/instances/{instance_id}/topics/{topic} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id
请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id}/users/{user_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
修改RocketMQ配置 功能介绍 该接口用于修改RocketMQ配置。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/rocketmq/instances/{instance_id}/configs 表1 路径参数 参数 是否必选 参数类型
调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rocketmq/{instance_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id
慎操作。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/instances/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 请求参数 表2 请求Body参数
查询指定实例的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id