检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 实例管理类接口 API 说明 生命周期管理 包括创建实例、修改实例信息、查询实例、删除实例、查询代理列表。 消费组管理 包括查询消费组、创建消费组、删除消费组、修改消费组、查询消费列表或详情、重置消费进度。 Topic管理 包括创建主题、删除主题、查询主题、修改
API V2(推荐) 生命周期管理 消费组管理 Topic管理 消息管理 用户管理 元数据迁移 参数管理 标签管理 其他接口 规格变更管理 实例管理
历史API API V1 API V2
API V2 查询指定实例 查询所有消费组 更新消费组 修改指定消费组 删除指定消费组 父主题: 历史API
API V1 实例管理类接口 其他接口 父主题: 历史API
查询产品规格 功能介绍 查询产品规格信息。 调用方法 请参见如何调用API。 URI GET /v1.0/products 表1 Query参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 product_id 是 String 产品ID。
查询实例 功能介绍 查询实例。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 project_id
查询实例列表 功能介绍 查询实例列表。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 请求参数
查询所有消费组 功能介绍 查询所有消费组。 调用方法 请参见如何调用API。 URI GET /v2/{engine}/{project_id}/instances/{instance_id}/groups 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String
其他接口 查询可用区 查询配额 查询实例在CES的监控层级关系 查询产品规格 父主题: API V1
实例管理类接口 创建实例 查询实例 查询实例列表 修改实例 删除实例 父主题: API V1
查询可用区 功能介绍 查询可用区。 调用方法 请参见如何调用API。 URI GET /v1.0/availableZones 请求参数 无 响应参数 状态码: 200 表1 响应Body参数 参数 参数类型 描述 region_id String 区域ID。 available_zones
查询指定实例 功能介绍 查询指定实例的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{engine}/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 引擎。
GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。
如何调用API 构造请求 认证鉴权 返回结果
删除指定的实例 功能介绍 删除指定的实例,释放该实例的所有资源。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
available_zones Array of strings 创建节点到指定且有资源的可用区ID。请参考查询可用区信息获取可用区ID。 该参数不能为空数组或者数组的值为空, 请注意查看该可用区是否有资源。 创建RocketMQ实例,支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时,用逗号分隔开。
更新消费组 功能介绍 更新消费组。 调用方法 请参见如何调用API。 URI PUT /v2/{engine}/{project_id}/instances/{instance_id}/groups 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 引擎。
查询配额 功能介绍 查询配额信息。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/quotas/dms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 请求参数
修改指定消费组 功能介绍 修改指定消费组。 调用方法 请参见如何调用API。 URI PUT /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group} 表1 路径参数 参数 是否必选 参数类型 描述 engine