API overview

更新时间:
复制 MD 格式

Message Queue provides the following Application Programming Interfaces (APIs).

Topic management

API

Description

CreateMqSofamqTopic

Creates a topic.

DeleteMqSofamqTopic

Deletes a topic.

ListMqSofamqTopic

Queries a list of topics.

UpdateMqSofamqTopic

Updates the read and write permissions of a topic.

UpdateMqSofamqTopicRemark

Modifies the description of a topic.

Group management

API

Description

CreateMqSofamqGroup

Creates a group.

DeleteMqSofamqGroup

Deletes a group.

ListMqSofamqGroup

Queries a list of groups.

QueryMqSofamqGroupSubDetail

Queries the subscription relationships of a group.

UpdateMqSofamqGroup

Updates the read permission of a group.

UpdateMqSofamqGroupRemark

Modifies the description of a group.

Consumer management

API

Description

QueryMqSofamqConsumerAccumulate

Queries the message backlog for a consumer.

GetMqSofamqConsumerStatus

Queries the detailed status of a consumer.

GetMqSofamqConsumerJStack

Queries the stack information of a consumer.

QueryMqSofamqConsumerConnection

Queries the connection information of a consumer.

ResetMqSofamqConsumerOffset

Resets a consumer offset.

QueryMqSofamqConsumerTimespan

Queries the time span of a consumer.

Message query

API

Description

GetMqSofamqMessageById

Queries a message by message ID.

QueryMqSofamqMessageByKey

Queries a message by message key.

QueryMqSofamqMessageByTopic

Queries messages by topic.

Message traces

API

Description

GetMqSofamqTraceResult

Views the result of a message trace query.

GetMqSofamqTraceByMsgId

Creates a message trace query task by message ID.

QueryMqSofamqTraceByMsgKey

Creates a message trace query task by message key.

QueryMqSofamqTraceByTopic

Creates a message trace query task by topic.

DeleteMqSofamqTrace

Deletes a message trace query task.

ListMqSofamqTrace

Queries a list of message trace query tasks.

Dead-letter queue

API

Description

GetMqSofamqDLQMessageById

Queries a dead-letter message by message ID.

QueryMqSofamqDLQMessageByGroupId

Queries dead-letter messages by group.

ResendMqSofamqDLQMessageById

Resends a dead-letter message.

ResendMqSofamqDLQMessageBatch

Resends dead-letter messages in a batch.

Alert management

API

Description

ListMqSofamqWarn

Queries a list of alert rules.

CreateMqSofamqWarn

Creates an alert rule.

DeleteMqSofamqWarn

Deletes an alert rule.

UpdateMqSofamqWarn

Updates an alert rule.

EnableMqSofamqWarn

Enables an alert rule.

DisableMqSofamqWarn

Disables an alert rule.

ListMqSofamqWarnHistory

Queries the alert history.