You need to enable JavaScript to run this app.
导航
API 概览
最近更新时间:2024.08.01 15:09:27首次发布时间:2023.07.27 17:33:07

本文汇总了云原生消息引擎提供的所有 API 接口。

实例规格

API

描述

ListSpecifications

调用 ListSpecifications 接口,查询 BMQ 支持的实例规格。

实例管理

API

描述

CreateInstance

调用 CreateInstance 接口,创建 BMQ 实例。

DeleteInstance

调用 DeleteInstance 接口,删除目标 BMQ 实例。

ModifyInstanceTag

调用 ModifyInstanceTag 接口,编辑实例的标签,支持新增、更新和删除标签。

DescribeInstance

调用 DescribeInstance 接口,查询目标 BMQ 实例详情。

SearchInstances

调用 SearchInstances 接口,查询符合条件的 BMQ 实例列表。

UpdateInstanceMessageRetention

调用 UpdateInstanceMessageRetention 接口,修改实例下所有 Topic 的默认消息保留时长。

ListInstanceResourceStats

调用 ListInstanceResourceStats 接口,同时查询多个 BMQ 实例所包含的资源。

DescribeInstanceResourceStat

调用 DescribeInstanceResourceStat 接口,查询单个 BMQ 实例所包含的资源。

Topic 管理

API

描述

CreateTopic

调用 CreateTopic 接口,创建 Topic。

DeleteTopic

调用 DeleteTopic 接口,删除目标 Topic。

ScaleUpTopic

调用 ScaleUpTopic 接口,扩容目标 Topic 的分区数。

DescribeTopic

调用 DescribeTopic 接口,查询目标 Topic 的详情。

SearchTopics

调用 SearchTopics 接口,查询符合条件的 Topic 列表。

TopicExist

调用 TopicExist 接口,判断 Topic 是否存在。

DescribePartitionsInTopic

调用 DescribePartitionsInTopic 接口,查询目标 Topic 的分区列表。

DescribeGroupsInTopic

调用 DescribeGroupsInTopic 接口,查询订阅目标 Topic 的 Consumer Group 列表。

UpdateTopicMessageRetention

调用 UpdateTopicMessageRetention 接口,修改目标 Topic 的消息保留时长。

PreviewTopicData

调用 PreviewTopicData 接口,预览目标 Topic 的消息数据。

DescribeTopicTimeRange

调用 DescribeTopicTimeRange 接口,查询 Topic 中消息生产时间范围,并判断是否存在消息。

Consumer Group 管理

API

描述

CreateGroup

调用 CreateGroup 接口,创建 Consumer Group。

DeleteGroup

调用 DeleteGroup 接口,删除目标 Consumer Group。

DescribeGroup

调用 DescribeGroup 接口,查询目标 Consumer Group 的详情。

SearchGroups

调用 SearchGroups 接口,查询符合条件的 Consumer Group 列表。

GroupExist

调用 GroupExist 接口,判断 Consumer Group 是否存在。

DescribeTopicsInGroup

调用 DescribeTopicsInGroup 接口,查询 Consumer Group 订阅的 Topic 列表。

DescribeSubscription

调用 DescribeSubscription 接口,查询 Consumer Group 订阅 Topic 的分区列表。

ResetSubscriptionOffset

调用 ResetPartitionOffset 接口,重置目标 Consumer Group 的分区消费位点。