QueryMqttTraceMessagePublish - Query message publish trace - ApsaraMQ for MQTT

Operation description

Each successful call to QueryMqttTraceMessagePublish counts toward your messaging TPS and affects billing. Billing rules.
Maximum: 500 calls per second per account. Exceeding this limit triggers throttling. Limits on QPS.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mq:QueryMqttPubTrace

none

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
MqttRegionId	string	Yes	The region ID of the ApsaraMQ for MQTT instance. Endpoints.	cn-hangzhou
InstanceId	string	Yes	The instance ID. Must match the instance used by your MQTT client. Find this value in the Basic Information section of the Instance Details page in the ApsaraMQ for MQTT console.	mqtt-cn-i7m26mf****
MsgId	string	Yes	The message ID.	AC1EC0030EAB78308DB16A3EC773****
BeginTime	integer	Yes	The start of the query time range. UNIX timestamp in milliseconds.	1618646400000
EndTime	integer	Yes	The end of the query time range. UNIX timestamp in milliseconds.	1621591200000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID for troubleshooting. This is a common parameter.	69AD5550-BF22-438A-9202-A6E89185****
MessageTraceLists	array<object>	The message traces.
	object
Time	string	The time when the message was sent.	2021-05-21 15:08:19.210
Action	string	The message action. Valid values: pub_mqtt: The message was sent by an ApsaraMQ for MQTT client. pub_mq: The message was sent by an ApsaraMQ for RocketMQ client.	pub_mqtt
ActionCode	string	The action code. Valid values: mqtt.trace.action.msg.pub.mqtt: Returned when Action is pub_mqtt. mqtt.trace.action.msg.pub.mq: Returned when Action is pub_mq.	mqtt.trace.action.msg.pub.mqtt
ActionInfo	string	The action description. Valid values: Pub From Mqtt Client: Returned when Action is pub_mqtt. Pub From MQ: Returned when Action is pub_mq.	Pub From Mqtt Client
MsgId	string	The message ID.	AC1EC0030EAB78308DB16A3EC773BD95
ClientId	string	The client ID of the message sender.	GID_test@@@producer

Examples

Success response

JSON format

{
  "RequestId": "69AD5550-BF22-438A-9202-A6E89185****",
  "MessageTraceLists": [
    {
      "Time": "2021-05-21 15:08:19.210",
      "Action": "pub_mqtt",
      "ActionCode": "mqtt.trace.action.msg.pub.mqtt",
      "ActionInfo": "Pub From Mqtt Client",
      "MsgId": "AC1EC0030EAB78308DB16A3EC773BD95",
      "ClientId": "GID_test@@@producer"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	MqttOwnerCheckError	Failed to validate the instance permission
500	SystemOverFlow	An error occurred while processing your request. Please try again.
404	ApiNotSupport	The specified API is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.