REST API Glossary
The following glossary explains the Request and Response Parameters provided in the examples above.
Minimum subscriber connections that this group should support. This parameter helps the scale-in process decide when to scale down an edge.
Minimum connections at the origin. This should always be zero (0) for the current version of Stream Manager.
Name of the launch configuration to be used for launching a new instance. Usually, this implies a consistent machine configuration for a group. A launch configuration defines your compute machine type, max connections, etc., for an instance.
Name of the scale policy to be used by Autoscaler to launch new edges when load conditions occur. A scale policy defines details such as min-max edges allowed etc.
Name of the stream for publishing or subscription.
Red5 scope where the stream exists. This is usually determined by the RTMP connection URL.
Host address of an available Red5 Pro origin server.
Descriptive information about the stream (optional).
A region code representing the region as supported by your cloud platform provider.
Total active subscribers count for this stream.
Stream start timestamp.
Unique Identifier of a node. Directly translates as virtual machine instance name.
Role of the instance in the system: Origin or Edge.
Maximum connection capacity of this instance as per launch configuration information.
Group name identifier.
Id of an alarm.
Alarm type. Generally, the type will be either scale-out or scale-in.
Metric that the alarm is set to monitor.
The threshold value for the alarm. Autoscaling events will happen when the threshold value is exceeded.
The comparator enum for threshold evaluation on this alarm. Comparators are comparision operators used to evaluate conditions at runtime using the threshold values and current value of the targeted metric.
Target type enum of the alarm. This is always set to GROUP, In current versions of Stream Manager alarms are meant for groups only.
Name of the VOD m3u8 playlist on cloud storage.
Name of the VOD mp4/flv media on cloud storage.
Time duration of the VOD content (in seconds).
Last modified timestamp of the VOD content on the cloud.
The absolute HTTP(s) URL of the m3u8 playlist.
The URL of the flv/mp4 media file.
Human-friendly error message string.
Timestamp for when the error message was generated.
Total connections observed on the node group
Total nodes in the group. This includes nodes in different states.
Total active nodes in the group. This includes nodes in active state (INSERVICE) only.
Total available connection capacity of the given node role. This is a cumulative total of individual node capacities belonging to the same node role.
Total available connection load (count) of the given node role. This is a cumulative total of individual node capacities belonging to the same node role. You can calculate the net percentage using the values of total-available-capacity and total-connection-load.
The name of the scale policy
The version of the scale policy format. Currently, Red5 Pro autoscaling supports two versions of the scale policy - standard (identified by version
0.0.2) and region-focused (identified by
A string representing the policy class used for representing the current policy. Version
The minimum number of nodes to have for the specified node role.
The maximum number of nodes to have for the specified node role.
This property is currently not active.
The name of the launch configuration.
The description of the launch configuration.
The name of the Red5 Pro disk image created for autoscaling on the cloud platform. For simulated cloud platforms, this value is not important.
The instance type of the VM/hardware which is used to identify the machine configuration to be used for running the Red5 Pro instance.
The arbitrary name of a property used in a launch configuration or scale policy.
The arbitrary value of a property used in a launch configuration or scale policy.
The arbitrary name of a meta tag used in a launch configuration or scale policy. Meta tags are used to add metadata to instances.
The arbitrary value for a meta-tag used in a launch configuration or scale policy. Meta tags are used to add metadata to instances.
The publish start timestamp of the stream as UTC milliseconds
The unpublish timestamp of the stream as UTC milliseconds
The total duration of the broadcast session in milliseconds
The last known number of active subscribers for the stream
The last known maximum number of simultaneous subscribers for the stream
The last known total number of subscribers for the stream. The value is calculated using the
The alphabetic string representing the geozone name.
The unique alphabetic string representing the geozone. The code is a single word that must not contain space.
An auto-generated id used to represent a scheduled event internally.
A unique string identifier used to identify and operate on a
scheduled event using the streammanager
Auto-generated client ID representing the proxy connection
The destination Host/IP of the target server that the proxy connection is connected to
Boolean connected state of the browser client participating in the proxy connection
boolean connected state of the server-side proxy client participating in the proxy connection
The user agent string of the client participating in the proxy connection
The remote IP of the client participating in the proxy connection
boolean value denoting whether the client of the proxy connection connects over SSL or not
The proxy connection creation time in UTC milliseconds