This product(
Ons/2019-02-14) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Service
| API | Title | Description |
|---|---|---|
| OpenOnsService | OpenOnsService | Activates ApsaraMQ for RocketMQ. |
Message
| API | Title | Description |
|---|---|---|
| OnsMessageTrace | OnsMessageTrace | Queries the consumption status of a message by using the message ID. |
| OnsMessageGetByMsgId | {"title1":"OnsMessageGetByMsgId"} | Queries the information about a message by specifying the message ID and determines whether the message has been consumed. |
| OnsMessageGetByKey | OnsMessageGetByKey | Queries messages by using a specified topic and message key. |
| OnsMessagePageQueryByTopic | {"title1":"OnsMessagePageQueryByTopic"} | Queries all messages that are stored in a specified topic within a specified time range by page. |
| OnsMessageDetail | OnsMessageDetail | Queries the details of a message. |
Region
| API | Title | Description |
|---|---|---|
| OnsRegionList | OnsRegionList | Queries regions where ApsaraMQ for RocketMQ is available. |
Instance
| API | Title | Description |
|---|---|---|
| OnsInstanceCreate | OnsInstanceCreate | Creates a ApsaraMQ for RocketMQ instance. |
| OnsInstanceBaseInfo | OnsInstanceBaseInfo | Queries the basic information of a ApsaraMQ for RocketMQ instance and the endpoint that a client uses to connect to the ApsaraMQ for RocketMQ instance to send and receive messages. |
| OnsInstanceUpdate | OnsInstanceUpdate | Updates the name and description of a ApsaraMQ for RocketMQ instance. |
| OnsInstanceInServiceList | OnsInstanceInServiceList | Queries the information about all ApsaraMQ for RocketMQ 4.x instances in a region in the current Alibaba Cloud account. |
| OnsInstanceDelete | OnsInstanceDelete | Deletes a specific ApsaraMQ for RocketMQ instance. |
Topic
| API | Title | Description |
|---|---|---|
| OnsTopicCreate | {"title1":"OnsTopicCreate"} | Creates a topic. |
| OnsTopicStatus | OnsTopicStatus | Queries the total number of messages in a topic and the status of the topic. |
| OnsTopicList | OnsTopicList | Queries the information about topics that belong to the current account. |
| OnsTopicSubDetail | OnsTopicSubDetail | Queries the online consumer groups that subscribe to a specified topic. |
| OnsTopicDelete | OnsTopicDelete | Deletes a topic. |
Group
| API | Title | Description |
|---|---|---|
| OnsGroupCreate | OnsGroupCreate | Creates a consumer group. |
| OnsGroupConsumerUpdate | OnsGroupConsumerUpdate | Configures read permissions on messages for a consumer group that is identified by a group ID. You can call this operation in scenarios in which you want to forbid consumers in a specific group from reading messages. |
| OnsGroupList | OnsGroupList | Queries one or more group IDs. |
| OnsGroupSubDetail | OnsGroupSubDetail | Queries all topics to which a specified consumer group subscribes. If no consumer instance in the consumer group is online, no data is returned. |
| OnsGroupDelete | OnsGroupDelete | Deletes a consumer group. |
Tag
| API | Title | Description |
|---|---|---|
| ListTagResources | ListTagResources | Queries the tags that are attached to a specified resource. |
| TagResources | TagResources | Attaches tags to resources. |
| UntagResources | UntagResources | Detaches and removes tags from a specific resource. |
Consumer
| API | Title | Description |
|---|---|---|
| OnsConsumerStatus | OnsConsumerStatus | Queries the detailed information about the status of a specified consumer group. This operation returns the transactions per second (TPS) for message consumption, load balancing status, consumer connection status, and whether all consumers in the consumer group subscribe to the same topics and tags. |
| OnsConsumerAccumulate | OnsConsumerAccumulate | Queries the information about message accumulation in topics to which a specified consumer group subscribes. The returned information includes the number of accumulated messages and the consumption latency. |
| OnsConsumerGetConnection | OnsConsumerGetConnection | Queries the client connection status of a specified consumer group. |
| OnsConsumerResetOffset | OnsConsumerResetOffset | Resets a consumer offset to a specified timestamp for a consumer group. |
| OnsConsumerTimeSpan | OnsConsumerTimeSpan | Queries the time range within which you can specify a point in time to reset the consumer offset for a specified topic. The time range is from the point in time when the earliest stored message was published to the topic to the point in time when the most recently stored message was published to the topic. |
| OnsMessagePush | {"title1":"OnsMessagePush"} | Pushes a message to a specified consumer. |
Messages tatistics
| API | Title | Description |
|---|---|---|
| OnsTrendTopicInputTps | OnsTrendTopicInputTps | Queries the statistics about messages that are published to a topic within a specific period of time. |
| OnsTrendGroupOutputTps | OnsTrendGroupOutputTps | Queries the statistics about messages that are consumed by a consumer group within a specific period of time. |
Trace
| API | Title | Description |
|---|---|---|
| OnsTraceQueryByMsgId | {"title1":"OnsTraceQueryByMsgId"} | Creates a task to query the trace of a message based on the message ID and the name of the topic in which the message is stored. The task ID is returned. |
| OnsTraceQueryByMsgKey | OnsTraceQueryByMsgKey | Creates a message trace query task based on the topic name and message key to obtain the ID of the query task. To obtain the query task details, you must call the OnsTraceGetResult operation and specify the query task ID that is returned by the OnsTraceQueryByMsgKey operation. |
| OnsTraceGetResult | {"title1":"OnsTraceGetResult"} | The tracing results are queried by specifying the ID of a trace query task. |
Dead-letter queues
| API | Title | Description |
|---|---|---|
| OnsDLQMessagePageQueryByGroupId | OnsDLQMessagePageQueryByGroupId | Queries all dead-letter messages in a group within a period of time by page. |
| OnsDLQMessageGetById | OnsDLQMessageGetById | Queries a dead-letter message based on the message ID. The queried information about the dead-letter message includes the point in time when the message is stored, the message body, and attributes such as the message tag and the message key. |
| OnsDLQMessageResendById | OnsDLQMessageResendById | Resends a dead-letter message based on a specified message ID so that the dead-letter message can be consumed by consumers. |