Retainer

Update retainer config.

put/mqtt/retainer

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/mqtt/retainer
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Request body

enableboolean

Enable retainer feature

msg_expiry_intervalstring

Message retention time. 0 means message will never be expired.

msg_clear_intervalstring

Periodic interval for cleaning up expired messages.<br/>Never clear if the value is 0.<br/>

max_payload_sizestring

Maximum retained message size.

stop_publish_clear_msgboolean

When the retained flag of the PUBLISH message is set and Payload is empty,<br/>whether to continue to publish the message.<br/>See:<br/>http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718038

Example request

{
  "msg_expiry_interval": "32s",
  "msg_clear_interval": "32s",
  "flow_control": {
    "batch_deliver_limiter": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB",
      "client": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      }
    }
  },
  "max_payload_size": "32MB",
  "backend": {
    "index_specs": [
      [
        2,
        4
      ],
      [
        1,
        3
      ]
    ]
  }
}

Response

Update configs successfully.

enableboolean

Enable retainer feature

msg_expiry_intervalstring

Message retention time. 0 means message will never be expired.

msg_clear_intervalstring

Periodic interval for cleaning up expired messages.<br/>Never clear if the value is 0.<br/>

max_payload_sizestring

Maximum retained message size.

stop_publish_clear_msgboolean

When the retained flag of the PUBLISH message is set and Payload is empty,<br/>whether to continue to publish the message.<br/>See:<br/>http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718038

Example response

{
  "msg_expiry_interval": "32s",
  "msg_clear_interval": "32s",
  "flow_control": {
    "batch_deliver_limiter": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB",
      "client": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      }
    }
  },
  "max_payload_size": "32MB",
  "backend": {
    "index_specs": [
      [
        2,
        4
      ],
      [
        1,
        3
      ]
    ]
  }
}

Changes

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