API Introduction
Used to view message consumption results.
API Restrictions
None.
URl
GET https://[endpoint]/v2/message/trace
Request Parameters
Request Parameters | Required or Not | Position | Parameter Type | Description |
msgId | Yes | url | String | Message ID |
prodInstId | Yes | url | String | Instance ID |
groupName | Yes | url | String | Subscription Group Name |
Response Parameter
Response Parameter | Parameter Type | Description |
statusCode | String | The status code of the interface on the system layer. Success: 800; failure: 900. |
message | String | Status Description |
returnObj | String | Return the object. The parameters included in this parameter are described in the comments in Response Examples. |
Description of Return Value data
Response Parameter | Parameter Type | Description |
msgId | String | Message ID |
clusterName | String | Instance ID |
consumeStatusList | List<Pair<String,String>> | object1: Subscription group object2: Consumption status |
Sample Request
GET https://[endpoint]/v2/message/trace?msgId= C0A847BC000020E600000000000045FE&prodInstId=70687660456281088&groupName=group
Examples of a Successful Response
{
"returnObj":{
"data":{
"msgId":"C0A847BC000020E60000000000003FEE",
"clusterName":"mq_test",
"consumeStatusList":[
{
"object1":"group",
"object2":"TO_CONSUME"
}
]
}
},
"message":"success",
"statusCode":800
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}