GetMqSofamqTraceResult-Scalable Open Financial Architecture(SOFAStack)-阿里云帮助中心

After a trace query task is created using a message ID or a message key, a task ID is returned. You can then call this operation with the task ID to retrieve the detailed results of the trace query.

Test

You can test this operation in OpenAPI Explorer without having to calculate a signature. Upon successful execution, OpenAPI Explorer automatically generates software development kit (SDK) code examples.

Request parameters

Name	Type	Required	Example	Description
Action	String	Yes	GetMqSofamqTraceResult	A required parameter. The value must be `GetMqSofamqTraceResult`.
InstanceId	String	Yes	MQ_INST_111111111111_DOxxxxxx	The instance ID.
QueryId	String	Yes	272967562652883649157096685****	The ID of the message trace query task.

Returned data

Name	Type	Example value	Description
Data	Struct		The detailed results of the query task.
CreateTime	Long	1570966857000	The time when the query task was created.
InstanceId	String	MQ_INST_111111111111_DOxxxxxx	The instance ID.
MsgId	String	1E05791C117818B4AAC23B1BB0CE****	The message ID that corresponds to the query task.
MsgKey	String	keyA	The message key that corresponds to the query task.
QueryId	String	272967562652883649157096685****	The ID of the query task.
Status	String	finish	The result of the query task. Valid values: finish: The query is complete. working: The query is in progress. removed: The task is deleted.
Topic	String	topic_a	The topic of the query task.
TraceList	Array		The list of matched traces for the query task.
BornHost	String	30.5..	The client address of the message sender.
Cell	String	RZ00A	The cell name of the producer.
CostTime	Long	24	The time taken to send the message. Unit: milliseconds.
MsgId	String	0BC1F01800002A9F000000531246****	The ID of the message, which is the message ID.
MsgKey	String	ORDERID_100	The key of the message, which is the message key.
PubGroupName	String	GID_test	The Group ID configured on the sender client.
PubTime	Long	1570850870478	The time when the message was sent.
Status	String	SEND_SUCCESS	The sending status. Valid values: SEND_SUCCESS: The message was sent successfully. SEND_FAILED: The message failed to be sent. SEND_ROLLBACK: The transactional message was rolled back. SEND_UNKNOWN: The transactional message was not committed. SEND_DELAY: The scheduled (delayed) message is waiting to be sent.
SubList	Array		The list of consumption traces for the message.
Cell	String	RZ00A	The cell name.
ClientList	Array		The list of detailed consumption records for the clients in this Group ID.
ClientHost	String	30.5..	The client address of the consumer.
CostTime	Long	43	The time taken for this consumption. Unit: milliseconds.
ReconsumeTimes	Long	1	The number of delivery attempts for this consumption.
Status	String	CONSUME_SUCCESS	The consumption status. Valid values: CONSUME_FAILED: Consumption failed. CONSUME_SUCCESS: Consumption was successful. CONSUME_NOT_RETURN: No result was returned for the consumption. SEND_UNKNOWN: The transactional message was not committed. SEND_DELAY: The scheduled (delayed) message is waiting to be sent.
SubGroupName	String	GID_test	The Group ID to which the client belongs.
SubTime	Long	1570851590511	The UNIX timestamp for when consumption started.
FailCount	Long	0	The number of failed consumption attempts for this Group ID.
SubGroupName	String	GID_test	The Group ID of the consumer.
SuccessCount	Long	1	The number of successful consumption attempts for this Group ID.
Tag	String	TagA	The tag of the message, which is the message tag.
Topic	String	test	The topic of the message.
UpdateTime	Long	1570966857000	The time when the query task was last updated.
UserId	String	27296756265288****	The ID of the user who made the query.
RequestId	String	861E6630-AEC0-4B2D-B214-6CB5E44B7F04	The request ID.
ResultCode	String	OK	The result code.
ResultMessage	String	OK	The result message.

Examples

Request example

http(s)://[Endpoint]/?Action=GetMqSofamqTraceResult
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&QueryId=272967562652883649157096685****
&<Common request parameters>

Response examples

XML format

<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<Data>
    <Status>finish</Status>
    <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
    <UserId>27296756265288****</UserId>
    <CreateTime>1570966857000</CreateTime>
    <MsgKey>keyA</MsgKey>
    <QueryId>272967562652883649157096685****</QueryId>
    <UpdateTime>1570966857000</UpdateTime>
    <TraceList>
        <CostTime>24</CostTime>
        <Status>SEND_SUCCESS</Status>
        <MsgKey>ORDERID_100</MsgKey>
        <BornHost>30.5.**.**</BornHost>
        <Tag>TagA</Tag>
        <PubGroupName>GID_test</PubGroupName>
        <PubTime>1570850870478</PubTime>
        <Topic>test</Topic>
        <Cell>RZ00A</Cell>
        <MsgId>0BC1F01800002A9F000000531246****        </MsgId>
    </TraceList>
    <TraceList>
        <SubList>
            <FailCount>0</FailCount>
            <SubGroupName>GID_test</SubGroupName>
            <SuccessCount>1</SuccessCount>
            <Cell>RZ00A</Cell>
        </SubList>
        <SubList>
            <ClientList>
                <CostTime>43</CostTime>
                <Status>CONSUME_SUCCESS</Status>
                <ClientHost>30.5.**.**</ClientHost>
                <SubTime>1570851590511</SubTime>
                <SubGroupName>GID_test</SubGroupName>
                <ReconsumeTimes>1</ReconsumeTimes>
            </ClientList>
        </SubList>
    </TraceList>
    <Topic>topic_a</Topic>
    <MsgId>1E05791C117818B4AAC23B1BB0CE****</MsgId>
</Data>
<ResultMessage>OK</ResultMessage>
<ResultCode>OK</ResultCode>

JSON format

{"RequestId":"861E6630-AEC0-4B2D-B214-6CB5E44B7F04","Data":{"Status":"finish","InstanceId":"MQ_INST_111111111111_DOxxxxxx","UserId":"27296756265288****","CreateTime":"1570966857000","MsgKey":"keyA","QueryId":"272967562652883649157096685****","UpdateTime":"1570966857000","TraceList":[{"CostTime":"24","Status":"SEND_SUCCESS","MsgKey":"ORDERID_100","BornHost":"30.5.**.**","Tag":"TagA","PubGroupName":"GID_test","PubTime":"1570850870478","Topic":"test","Cell":"RZ00A","MsgId":"0BC1F01800002A9F000000531246****\t"},{"SubList":[{"FailCount":"0","SubGroupName":"GID_test","SuccessCount":"1","Cell":"RZ00A"},{"ClientList":[{"CostTime":"43","Status":"CONSUME_SUCCESS","ClientHost":"30.5.**.**","SubTime":"1570851590511","SubGroupName":"GID_test","ReconsumeTimes":"1"}]}]}],"Topic":"topic_a","MsgId":"1E05791C117818B4AAC23B1BB0CE****"},"ResultMessage":"OK","ResultCode":"OK"}

Error codes

For more information about error codes, see the Error Center.