Trace

Stop trace by name

put/trace/{name}/stop

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/trace/{name}/stop
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Path parameters

namestring required

[a-zA-Z0-9-_]

Response

namestring required

Unique and format by [a-zA-Z0-9-_]

type'clientid' | 'topic' | 'ip_address' required

Filter type

topicstring

support mqtt wildcard topic.

clientidstring

mqtt clientid.

ip_addressstring

client ip address

status'running' | 'stopped' | 'waiting'

trace status

log_sizeobject[]

trace log size

Example response

{
  "name": "EMQX-TRACE-1",
  "type": "clientid",
  "topic": "/dev/#",
  "clientid": "dev-001",
  "ip_address": "127.0.0.1",
  "status": "running",
  "start_at": 1640995200,
  "end_at": 1640995200,
  "log_size": [
    {
      "node": "emqx@127.0.0.1",
      "size": 1024
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.