更新时间:2024-10-21 GMT+08:00

API概览

表1 实例管理类接口

API

说明

生命周期管理

包括创建实例、查询所有实例列表、查询指定实例、删除指定的实例、修改实例信息、批量重启或删除实例、获取实例配置、修改实例配置、实例升级。

实例管理

包括重置密码、重置Manager密码、重启Manager、开启或关闭实例自动创建Topic功能、修改实例跨VPC访问的内网IP、查询Kafka集群元数据信息、查询消费组信息、查询Kafka实例的协调器信息、修改Kafka实例Topic分区的副本、查询Topic的磁盘存储情况、查询所有消费组、Kafka实例批量删除消费组、创建消费组、编辑消费组、Kafka实例开始分区重平衡任务、关闭Kafka Manager、删除用户/客户端流控配置、查询用户/客户端流控配置、创建用户/客户端流控配置、修改用户/客户端流控配置、重置消费组消费进度到指定位置。

Smart Connect

包括开启Smart Connect(按需实例)、关闭Smart Connect(按需实例)、创建Smart Connect任务、查询Smart Connect任务列表、查询Smart Connect任务详情、删除Smart Connect任务、暂停Smart Connect任务、启动已暂停的Smart Connect任务、启动未启动的Smart Connect任务/重启已暂停或者运行中的Smart Connect任务。

规格变更管理

包括查询实例的扩容规格列表、实例扩容。

主题管理

包括Kafka生产消息、Kafka实例创建Topic、Kafka实例查询Topic、修改Kafka实例Topic、Kafka实例批量删除Topic、查询Topic的分区列表、查询Topic的当前生产者列表、查询Kafka实例Topic详细信息。

用户管理

包括查询用户列表、创建用户、批量删除用户、重置用户密码、修改用户参数、查询用户权限、设置用户权限。

消息查询

包括查询消息、查询分区指定偏移量的消息、查询分区指定时间段的消息、查询分区最早消息的位置、查询分区最新消息的位置。

后台任务管理

包括查询实例的后台任务列表、查询后台任务管理中的指定记录、删除后台任务管理中的指定记录。

标签管理

包括批量添加或删除实例标签、查询实例标签、查询项目标签。

诊断管理

包括消息积压诊断预检查、创建消息积压诊断任务、查询消息积压诊断报告列表、批量删除消息积压诊断报告、查询诊断报告详情。

其他接口

包括查询产品规格列表、查询可用区信息、查询维护时间窗时间段、查询实例在CES的监控层级关系。