You need to enable JavaScript to run this app.
导航

API 概览

最近更新时间2023.12.14 21:43:10

首次发布时间2023.07.12 16:22:33

消息队列 RocketMQ版提供以下相关 API 接口。

资源检查

API

说明

DescribeRegions

调用 DescribeRegions 接口查看 Region 列表。

DescribeAvailabilityZones

调用 DescribeAvailabilityZones 接口查看可用区列表。

实例管理

API

说明

CreateInstance

调用 CreateInstance 创建消息队列 RocketMQ版实例。

DescribeInstances

调用 DescribeInstances 接口获取当前账户下的实例列表。

DescribeInstanceDetail

调用 DescribeInstanceDetail 接口查看指定实例的详情。

DeleteInstance

调用 DeleteInstance 接口释放按量付费实例。

ModifyInstanceAttributes

调用 ModifyInstanceAttributes 接口修改对应实例名称、描述等实例信息。

ModifyInstanceSpec

调用 ModifyInstanceSpec 接口修改实例的计算规格、存储规格、增配分区数等产品规格。

ModifyInstanceChargeType

调用 ModifyInstanceChargeType 接口修改实例的计费方式。

网络管理

API

说明

CreatePublicAddress

调用 CreatePublicAddress 接口开启实例的公网访问。

DeletePublicAddress

调用 DeletePublicAddress 接口关闭实例的公网访问。

Topic 管理

API

说明

CreateTopic

用CreateTopic接口创建 Topic。

DeleteTopic

调用DeleteTopic接口删除 Topic。

DescribeTopicAccessPolicies

调用 DescribeTopicAccessPolicies 接口查看 Topic 的权限列表。

ModifyTopicAccessPolicies

调用 ModifyTopicAccessPolicies 接口设置 Topic 的权限策略。

DescribeTopics

调用 DescribeTopics 接口查看 Topic 列表。

DescribeTopicQueue

调用 DescribeTopicQueue 接口获取 Topic 的队列信息。

DescribeTopicGroups

调用 DescribeTopiGroups 接口获取 Topic 的 Group 信息。

Group 管理

API

说明

CreateGroup

调用 CreateGroup 创建一个新的消费组(Group)。

DeleteGroup

调用 DeleteGroup 删除消费组(Group)。

DescribeGroups

调用 DescribeGroups 接口获取消费组列表。

DescribeGroupsDetail

调用 DescribeGroupsDetail 接口查看指定 Group 的详细信息。

DescribeConsumedTopics

调用 DescribeConsumedTopics 接口查看 Group 订阅的 Topic 信息。

DescribeConsumedTopicDetail

调用 DescribeConsumedTopics 查看 Group 消费 Topic 的进度。

DescribeConsumedClients

调用 DescribeConsumedClients 接口查看 Group 连接的客户端信息。

ResetConsumedOffsets

调用 ResetConsumedOffsets 接口重置消费者组消费的消费位点。

消息查询

API

说明

QueryMessageByMsgId

调用 QueryMessageByMsgId 查询 Topic 中指定 MessageId 的消息元数据。

QueryMessageByMsgKey

调用 QueryMessageByMsgKey 可以查询 Topic 中指定 MessageKey 的消息元数据。

QueryMessageByTimestamp

调用 QueryMessageByTimestamp 查询分区中指定时间范围内的消息元数据。

死信队列管理

API

说明

QueryDLQMessageById

调用 QueryDLQMessageById 可以查询指定 MessageID 的死信消息。

QueryDLQMessageByGroupId

调用 QueryDLQMessageByGroupId 接口根据时间范围查询指定 Group 的死信消息。

ResendDLQMessageById

调用 ResendDLQMessageById 接口重新发送指定 MessageID 的死信消息。

密钥管理

API

说明

CreateAccessKey

调用 CreateAccessKey 创建 RocketMQ 密钥。

DescribeSecretKey

调用 DescribeSecretKey 接口查看指定 RocketMQ 密钥的 AccessKey Secret。

DeleteAccessKey

调用 DeleteAccessKey 接口删除 RocketMQ 密钥。

ModifyAccessKeyAllAuthority

调用 ModifyAccessKeyAllAuthority 接口修改 RocketMQ 密钥的默认权限。

ModifyAccessKeyAuthority

调用 ModifyAccessKeyAuthority 接口设置 RocketMQ 密钥的自定义权限。

DescribeAccessKeys

调用 DescribeAccessKeys 接口查询 RocketMQ 密钥列表。

DescribeAccessKeyDetail

调用 DescribeAccessKeyDetail 接口查询指定 RocketMQ 密钥的详细信息。

标签管理

API

说明

AddTagsToResource

调用 AddTagsToResource 接口为指定实例绑定标签。

RemoveTagsFromResource

调用 RemoveTagsFromResource 接口为一个或多个实例解绑标签。

DescribeTagsByResource

调用 DescribeTagsByResource 接口查询已绑定标签的资源。

白名单管理

API

说明

CreateAllowList

调用 CreateAllowList 接口创建一个新的 IP 白名单规则。

ModifyAllowList

调用 ModifyAllowList 修改一个已经创建的白名单规则。

DeleteAllowList

调用 DeleteAllowList 删除一个已经创建的白名单规则。

DescribeAllowLists

调用 DescribeAllowLists 查询白名单列表。

DescribeAllowListDetail

调用 DescribeAllowListDetail 查询指定白名单的详细信息。

AssociateAllowList

调用 AssociateAllowList 绑定实例与白名单。

DisassociateAllowList

调用 DisassociateAllowList 解绑实例与白名单。