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

[rocketmq-apis] 01/02: Polish the status_code.md

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

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

commit 7c3a20fe07587ee86004682bdb64a6c4981779ca
Author: 凌楚 <ya...@alibaba-inc.com>
AuthorDate: Thu Jun 30 10:50:47 2022 +0800

    Polish the status_code.md
---
 status_code.md | 48 +++++++++++++++++++++++++++---------------------
 1 file changed, 27 insertions(+), 21 deletions(-)

diff --git a/status_code.md b/status_code.md
index 732e828..9e0efbd 100644
--- a/status_code.md
+++ b/status_code.md
@@ -2,9 +2,13 @@
 
 ## Non-Telemetry RPC Status Code Mapping Table
 
-|                                              | QueryRoute | Heartbeat | SendMessage | QueryAssignment | ReceiveMessage | AckMessage | ForwardMessageToDeadLetterQueue | EndTransaction | NotifyClientTermination | ChangeInvisibleDuration |
+> **Note**: The status code with asterisk(*) means it is first classification, '🔄 ' means the code is reserved.
+
+|                 Status Code                  | QueryRoute | Heartbeat | SendMessage | QueryAssignment | ReceiveMessage | AckMessage | ForwardMessageToDeadLetterQueue | EndTransaction | NotifyClientTermination | ChangeInvisibleDuration |
 | :------------------------------------------: | :--------: | :-------: | :---------: | :-------------: | :------------: | :--------: | :-----------------------------: | :------------: | :---------------------: | :---------------------: |
-|                      OK                      |     ✅      |     ✅     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ✅        |            ✅            |            ✅            |
+|                     OK*                      |     ✅      |     ✅     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ✅        |            ✅            |            ✅            |
+|              MULTIPLE_RESULTS*               |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ✅      |                ❌                |       ❌        |            ❌            |            ❌            |
+|                 BAD_REQUEST*                 |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |             ILLEGAL_ACCESS_POINT             |     ✅      |     ❌     |      ❌      |        ✅        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |                ILLEGAL_TOPIC                 |     ✅      |     ✅     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ✅        |            ❌            |            ✅            |
 |            ILLEGAL_CONSUMER_GROUP            |     ❌      |     ✅     |      ❌      |        ❌        |       ✅        |     ✅      |                ✅                |       ✅        |            ✅            |            ✅            |
@@ -14,31 +18,33 @@
 |         ILLEGAL_MESSAGE_PROPERTY_KEY         |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |         MESSAGE_PROPERTIES_TOO_LARGE         |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |            MESSAGE_BODY_TOO_LARGE            |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|                  FORBIDDEN                   |     ❌      |     ❌     |      ✅      |        ✅        |       ✅        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|                 UNAUTHORIZED                 |     ❌      |     ✅     |      ✅      |        ❌        |       ✅        |     ✅      |                ✅                |       ✅        |            ✅            |            ✅            |
-|               TOPIC_NOT_FOUND                |     ✅      |     ❌     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ❌        |            ❌            |            ✅            |
-|           CONSUMER_GROUP_NOT_FOUND           |     ❌      |     ❌     |      ❌      |        ❌        |       ✅        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|       VERIFY_FIFO_MESSAGE_UNSUPPORTED        |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|          FAILED_TO_CONSUME_MESSAGE           |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|              MESSAGE_CORRUPTED               |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|              TOO_MANY_REQUESTS               |     ✅      |     ✅     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ✅        |            ✅            |            ✅            |
-| MESSAGE_PROPERTY_DOES_NOT_MATCH_MESSAGE_TYPE |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|              ILLEGAL_MESSAGE_ID              |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |            INVALID_TRANSACTION_ID            |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ✅        |            ❌            |            ❌            |
+|              ILLEGAL_MESSAGE_ID              |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |          ILLEGAL_FILTER_EXPRESSION           |     ❌      |     ❌     |      ❌      |        ❌        |       ✅        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |            INVALID_RECEIPT_HANDLE            |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ✅      |                ✅                |       ❌        |            ❌            |            ✅            |
-|          MASTER_PERSISTENCE_TIMEOUT          |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|          SLAVE_PERSISTENCE_TIMEOUT           |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|               HA_NOT_AVAILABLE               |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|             VERSION_UNSUPPORTED              |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
-|              MESSAGE_NOT_FOUND               |     ❌      |     ❌     |      ❌      |        ❌        |       ✅        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+| MESSAGE_PROPERTY_DOES_NOT_MATCH_MESSAGE_TYPE |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |           UNRECOGNIZED_CLIENT_TYPE           |     ❌      |     ✅     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ✅            |            ❌            |
-|               MULTIPLE_RESULTS               |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ✅      |                ❌                |       ❌        |            ❌            |            ❌            |
-|                 BAD_REQUEST                  |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+|              MESSAGE_CORRUPTED               |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |              CLIENT_ID_REQUIRED              |     ✅      |     ✅     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ✅        |            ✅            |            ✅            |
+|                UNAUTHORIZED*                 |     ❌      |     ✅     |      ✅      |        ❌        |       ✅        |     ✅      |                ✅                |       ✅        |            ✅            |            ✅            |
+|                  FORBIDDEN*                  |     ❌      |     ❌     |      ✅      |        ✅        |       ✅        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+|                  NOT_FOUND*                  |     🔄      |     🔄     |      🔄      |        🔄        |       🔄        |     🔄      |                🔄                |       🔄        |            🔄            |            🔄            |
+|              MESSAGE_NOT_FOUND               |     ❌      |     ❌     |      ❌      |        ❌        |       ✅        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+|               TOPIC_NOT_FOUND                |     ✅      |     ❌     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ❌        |            ❌            |            ✅            |
+|           CONSUMER_GROUP_NOT_FOUND           |     ❌      |     ❌     |      ❌      |        ❌        |       ✅        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+|              TOO_MANY_REQUESTS*              |     ✅      |     ✅     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ✅        |            ✅            |            ✅            |
+|               INTERNAL_ERROR&*               |     🔄      |     🔄     |      🔄      |        🔄        |       🔄        |     🔄      |                🔄                |       🔄        |            🔄            |            🔄            |
 |            INTERNAL_SERVER_ERROR             |     ✅      |     ✅     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ✅        |            ✅            |            ✅            |
-|               NOT_IMPLEMENTED                |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+|               HA_NOT_AVAILABLE               |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+|               NOT_IMPLEMENTED*               |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+|                   TIMEOUT*                   |     🔄      |     🔄     |      🔄      |        🔄        |       🔄        |     🔄      |                🔄                |       🔄        |            🔄            |            🔄            |
+|          MASTER_PERSISTENCE_TIMEOUT          |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+|          SLAVE_PERSISTENCE_TIMEOUT           |     ❌      |     ❌     |      ✅      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 |                PROXY_TIMEOUT                 |     ✅      |     ❌     |      ✅      |        ✅        |       ✅        |     ✅      |                ✅                |       ✅        |            ❌            |            ✅            |
+|                 UNSUPPORTED*                 |     🔄      |     🔄     |      🔄      |        🔄        |       🔄        |     🔄      |                🔄                |       🔄        |            🔄            |            🔄            |
+|             VERSION_UNSUPPORTED              |     🔄      |     🔄     |      🔄      |        🔄        |       🔄        |     🔄      |                🔄                |       🔄        |            🔄            |            🔄            |
+|       VERIFY_FIFO_MESSAGE_UNSUPPORTED        |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
+|          FAILED_TO_CONSUME_MESSAGE*          |     ❌      |     ❌     |      ❌      |        ❌        |       ❌        |     ❌      |                ❌                |       ❌        |            ❌            |            ❌            |
 
 ## Server-Client Telemetry RPC Status Code Mapping Table
 
@@ -48,4 +54,4 @@
 |         NOT_IMPLEMENTED         |        ✅         |          ❌          |
 |    FAILED_TO_CONSUME_MESSAGE    |        ❌         |          ✅          |
 | VERIFY_FIFO_MESSAGE_UNSUPPORTED |        ❌         |          ✅          |
-|        MESSAGE_CORRUPTED        |        ❌         |          ✅          |
\ No newline at end of file
+|        MESSAGE_CORRUPTED        |        ❌         |          ✅          |