检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 实例管理类接口 API 说明 生命周期管理 包括创建实例、查询所有实例列表、查询指定实例、删除指定的实例、修改实例信息、批量重启或删除实例、获取实例配置、修改实例配置、实例升级。 实例管理 包括重置密码、重置Manager密码、重启Manager、开启或关闭实例
API V2 查询产品规格列表 新增Kafka实例指定Topic分区 重置消费组消费进度到指定位置 修改转储任务的配额 创建关闭实例转储节点的订单 创建转储任务 查询转储任务列表 查询单个转储任务 删除单个转储任务 查询指定实例 查询所有消费组 父主题: 历史API
历史API API V1 API V2
实例使用类接口 查询分区指定偏移量的消息 查询分区指定时间段的消息 查询分区最新消息的位置 查询分区最早消息的位置 查询Kafka集群元数据信息 查询消费组信息 重置消费组消费进度到指定位置 查询Kafka实例所有消费组对应的协调器信息 查询Kafka实例Topic详细信息 新增Kafka实例指定Topic分区
如何调用API 构造请求 认证鉴权 返回结果
Kafka实例批量删除Topic 当前页面API为历史版本API,未来可能停止维护。请使用Kafka实例批量删除Topic。 功能介绍 该接口用于向Kafka实例批量删除Topic。 URI POST /v1.0/{project_id}/instances/{instance_id}/topics/delete
查询可用区信息 当前页面API为历史版本API,未来可能停止维护。请使用查询可用区信息。 功能介绍 在创建实例时,需要配置实例所在的可用区ID,可通过该接口查询可用区的ID。 URI GET /v1.0/availableZones 请求消息 请求参数 无。 请求示例 GET h
其他接口 查询可用区信息 查询产品规格列表 查询维护时间窗时间段 查询实例在CES的监控层级关系 查询实例在CES的监控层级关系 查询配额 父主题: API V1
API V1 实例管理类接口 实例使用类接口 其他接口 父主题: 历史API
查询可用区信息 功能介绍 在创建实例时,需要配置实例所在的可用区ID,可通过该接口查询可用区的ID。 调用方法 请参见如何调用API。 URI GET /v2/available-zones 请求参数 无 响应参数 状态码: 200 表1 响应Body参数 参数 参数类型 描述 region_id
其他接口 查询维护时间窗时间段 查询可用区信息 查询产品规格列表 查询实例在CES的监控层级关系 查询Kafka产品规格核数 父主题: API V2(推荐)
查询配额 功能介绍 查询配额详情。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/quotas/dms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 请求参数
实例管理类接口 创建Kafka实例 查询指定实例 修改实例信息 删除指定实例 批量重启、删除实例 查询所有实例列表 Kafka实例创建Topic Kafka实例查询Topic Kafka实例批量删除Topic 父主题: API V1
方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询VPC列表。 security_group_id String 是 指定实例所属的安全组。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询安全组列表。
API V2(推荐) 生命周期管理 实例管理 Smart Connect 规格变更管理 主题管理 消费组管理 用户管理 消息管理 后台任务管理 标签管理 诊断管理 其他接口
修改实例信息 当前页面API为历史版本API,未来可能停止维护。请使用修改实例信息。 功能介绍 修改实例的信息,包括实例名称、实例描述、实例维护时间窗、安全组等信息。 URI PUT /v1.0/{project_id}/instances/{instance_id} 表1 参数说明
查询产品规格列表 当前页面API为历史版本API,未来可能停止维护。请使用查询产品规格列表。 功能介绍 在创建kafka实例时,需要配置订购的产品ID(即product_id),可通过该接口查询产品规格。 例如,要订购按需计费、基准带宽为100MB的kafka实例,可从接口响应消息中,查找
删除指定实例 当前页面API为历史版本API,未来可能停止维护。请使用删除指定的实例。 功能介绍 删除指定的实例,释放该实例的所有资源。 URI DELETE /v1.0/{project_id}/instances/{instance_id} 参数说明见表1。 表1 参数说明 参数
查询消费组信息 当前页面API为历史版本API,未来可能停止维护。请使用查询消费组信息。 URI GET /v1.0/{project_id}/instances/{instance_id}/manage/groups/{group} 参数说明如下表所示。 表1 参数说明 参数 类型
Kafka实例查询Topic 当前页面API为历史版本API,未来可能停止维护。请使用Kafka实例查询Topic。 功能介绍 该接口用于查询指定Kafka实例的Topic详情。 URI GET /v1.0/{project_id}/instances/{instance_id}/topics