GET Messages: Get a List of Messages - AWS Elemental Conductor Live 3

This is version 3.17 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

GET Messages: Get a List of Messages

Get a list of messages on one or more nodes in the cluster.

HTTP Request and Response

Request URL

The request consists of the operation, the URL of the AWS Elemental Conductor Live 3 node, the messages request, and optional filter parameters. If using multiple filters, enter the ampersand (&) between each filter parameter. For example:

GET http://<Conductor IP address>/messages?<filter>=<value>&<filter>=<value>

The following filter parameters are available for the GET request. See the examplesfor a variety of filter parameters.

Filter Value Description
origin Integer

Filter for messages that were originate with a specific node. Enter the ID of the node as assigned by AWS Elemental Conductor Live 3.

See Where Alerts Come From and Where They Apply.

node Integer

Filter for messages that apply to a specific node. Enter the ID of the node as assigned by AWS Elemental Conductor Live 3.

Typically, for a node, do not enter both the origin and node filters.

channel Integer

Filter for messages that apply to a specific channel. Enter the ID of the channel as assigned by AWS Elemental Conductor Live 3.

You can enter both an origin and channel.

mpts Integer

Filter for messages that apply to a specific Multi-Program Transport Stream (MPTS) output. Enter the ID of the MPTS output as assigned by AWS Elemental Conductor Live 3.

You can enter both an origin and an MPTS.

type String Case-insensitive match. See the Status > Messages screen on the AWS Elemental Conductor Live 3 web interface for a list of applicable types.
code String Filter for only those messages with the specified message codes. Enter a comma-separated list of 1 or more numeric codes. For a list of codes, see the Status > Messages screen on the AWS Elemental Conductor Live 3 web interface.
page Integer Default is 1.
per_page Integer Default is 20.

Call Header

  • Accept: Set to application/xml

If you are implementing user authentication, you must also include three authorization headers; see Header Content for User Authentication .

Response

The response is XML content consisting of one message element with the following.

  • An HREF attribute that specifies the product and version installed on the AWS Elemental Conductor Live 3 node.

  • Several elements from the table below.

Element Value Description
id Integer A unique ID for this alert, assigned by AWS Elemental Conductor Live 3.
type String The type of the message.
code Integer The internal code assigned to this type of alert.
message String A longer description.
data String A data string that can hold additional information on the message.
notes String A notes string that is always null.
messageable_id Integer The unique ID for the entity in alertable_type. This is the ID that is included in the response of a GET. For example, GET Node includes the ID that uniquely identifies the node.
messageable_type String The type of the output in the channel (event) that this alert specifically applies to. Otherwise null.
node_id Integer The ID which identifies the same piece of data as the origin filter in the request; see GET Alerts: Get a List of Alerts.
remote_id Integer The ID of the entity (channel or MPTS) as assigned by the worker node that is running this entity. The ID assigned by AWS Elemental Conductor Live 3 may be different from the ID assigned by the worker node.
updated_at Time The last time this alert was updated.