You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by li...@apache.org on 2022/06/28 06:21:46 UTC

[rocketmq-apis] branch main updated: Docs: add error_code.md (#45)

This is an automated email from the ASF dual-hosted git repository.

lizhanhui pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/rocketmq-apis.git


The following commit(s) were added to refs/heads/main by this push:
     new f0884ea  Docs: add error_code.md (#45)
f0884ea is described below

commit f0884eac405663c77ae113423ffe5c5793e1ee09
Author: Aaron Ai <ya...@alibaba-inc.com>
AuthorDate: Tue Jun 28 14:21:41 2022 +0800

    Docs: add error_code.md (#45)
    
    * Docs: add error_code.md
    
    * Docs: polish error_code.md
    
    * Docs: fix typo in status_code.md
---
 status_code.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/status_code.md b/status_code.md
new file mode 100644
index 0000000..bfc6655
--- /dev/null
+++ b/status_code.md
@@ -0,0 +1,48 @@
+# Status Code
+
+## Non-Telemetry RPC Status Code Mapping Table
+
+|                                              | QueryRoute | Heartbeat | SendMessage | QueryAssignment | ReceiveMessage | AckMessage | ForwardMessageToDeadLetterQueue | EndTransaction | NotifyClientTermination | ChangeInvisibleDuration |
+| :------------------------------------------: | :--------: | :-------: | :---------: | :-------------: | :------------: | :--------: | :-----------------------------: | :------------: | :---------------------: | :---------------------: |
+|                      OK                      |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|             ILLEGA_ACCESS_POINT              |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|                ILLEGAL_TOPIC                 |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            ILLEGAL_CONSUMER_GROUP            |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|             ILLEGAL_MESSAGE_TAG              |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|             ILLEGAL_MESSAGE_KEY              |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            MESSAGE_KEYS_TOO_LARGE            |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            ILLEGAL_MESSAGE_GROUP             |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|         ILLEGAL_MESSAGE_PROPERTY_KEY         |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|         MESSAGE_PROPERTIES_TOO_LARGE         |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            MESSAGE_BODY_TOO_LARGE            |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|                  FORBIDDEN                   |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|                 UNAUTHORIZED                 |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|               TOPIC_NOT_FOUND                |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|           CONSUMER_GROUP_NOT_FOUND           |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|           VERIFY_MESSAGE_FORBIDDEN           |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|          FAILED_TO_CONSUME_MESSAGE           |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|              MESSAGE_CORRUPTED               |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|              TOO_MANY_REQUESTS               |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            RECEIPT_HANDLE_EXPIRED            |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+| MESSAGE_PROPERTY_DOES_NOT_MATCH_MESSAGE_TYPE |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|              ILLEGAL_MESSAGE_ID              |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            INVALID_TRANSACTION_ID            |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|          ILLEGAL_FILTER_EXPRESSION           |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            INVALID_RECEIPT_HANDLE            |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|          MASTER_PERSISTENCE_TIMEOUT          |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|          SLAVE_PERSISTENCE_TIMEOUT           |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|               HA_NOT_AVAILABLE               |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|             VERSION_UNSUPPORTED              |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|              MESSAGE_NOT_FOUND               |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            ILLEGAL_MESSAGE_OFFSET            |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|               ILLEGAL_MESSAGE                |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|           UNRECOGNIZED_CLIENT_TYPE           |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|               MULTIPLE_RESULTS               |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|               ILLEGAL_MESSAGE                |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|                 BAD_REQUEST                  |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            BAD_REQUEST_CLIENT_ID             |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|            INTERNAL_SERVER_ERROR             |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|               NOT_IMPLEMENTED                |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+|               GATEWAY_TIMEOUT                |     ✅      |     ❌     |      ✅      |        ❌        |       ✅        |     ❌      |                ✅                |       ❌        |            ✅            |            ❌            |
+
+## Telemetry RPC Status Code Mapping Table