REST API Glossary
The following glossary explains the Request and Response Parameters provided in the examples above.
- [origin-compute-region-code]FIXME-DOM(#origin-compute-region-code) -->
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 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 the 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, instances warm up time, cooldown period, etc.
Name of the stream for publishing or subscription.
Red5 scope where the stream exists. This 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 suuported by your cloud platform provider.Regions codes generally map your cloud providers's data center(s) at a region.
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.
Instance host name/address.
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.
Threshold value for the alarm.
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 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 on 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 invidual node capacities belonging to same node role.
Total available connection load (count) of the given node role. This is a cumulative total of invidual node capacities belonging to same node role. You can calculate the net percentage using the values of total-available-capacity and total-connection-load.