RTMP/E

 getVHostStats([adaptor:String, vhost:String]) : Object

HTTP

 http://www.example.com:1111/admin/getVHostStats?auser=username&apswd=password&adaptor=name&vhost=name

Returns aggregate performance data for all instances for all applications for the specified virtual host. You must be a server administrator to call this method.

Availability

Flash Communication Server 1.0.

Parameters

adaptor

A String indicating the user name of the adaptor. If not specified, it is assumed to be _defaultRoot_.

vhost

A String indicating the user name of the virtual host. If not specified, it is assumed to be _defaultVHost_.

auser

A String indicating the user name of the administrator.

apswd

A String indicating the password of the administrator.

Returns

RTMP/E

If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object containing the virtual host performance data. The data object has the following properties:

Property

Description

msg_in

Number; total number of messages processed by this virtual host.

msg_out

Number; total number of messages sent by this virtual host.

msg_dropped

Number; total number of messages dropped by this virtual host.

bytes_in

Number; total number of bytes read by this virtual host.

bytes_out

Number; total number of bytes written by this virtual host.

accepted

Number; total number connections accepted by this virtual host.

rejected

Number; total number of connections rejected by this virtual host.

connected

Number; total number of connections currently active.

total_apps

Number; total number of applications that have been created.

total_connects

Number; total number of connections to the server.

total_disconnects

Number; total number of disconnections from the server.

total_instances_loaded

Number; total number of instances that have been loaded.

This property does not represent the total number of active instances loaded. To get the number of active instances loaded, subtract the value of total_instances_unloaded from total_instances_loaded.

total_instances_unloaded

Number; total number of instances that have been unloaded.

server_bytes_in

Number; total number of rtmp bytes read by an SSAS NetConnection

server_bytes_out

Number; total number of rtmp bytes sent by an SSAS NetConnection

bw_in

Number; current bandwidth in, in bytes per second.

bw_out

Number; current bandwidth out, in bytes per second.

normal_connects

Number; total number of normal connections.

virtual_connects

Number; total number of connections through a remote edge.

group_connects

Number; total number of remote edges that are connected.

service_connects

Number; total number of service connections.

service_requests

Number; total number of services requested.

admin_connects

Number; total number of administrator connections.

debug_connects

Number; total number of debug connections.

swf_verification_attempts

A counter of the number of SWF verification attempts made. Represents the total SWF verification credentials passed to the server for checking. There may be more than one credential presented per connection.

swf_verification_exceptions

A counter of the number of SWF verification exceptions made. Exceptions are allowed through explicit configuration in the Application.xml file that allows certain user agents to bypass the requirement for SWF verification. Every connection allowed as an exception is counted here.

swf_verification_failures

A counter of the number of SWF verification failures. Failures result from the presentation of SWF verification credentials that are found not to be a match for any loaded credential. Each failure corresponds to a disconnection of the presenting connection.

swf_verification_unsupported_rejects

A counter of the number of SWF verification unsupported rejections. When a version of Flash Player that doesn’t support SWF verification connects to an application that requires SWF verification, the unsupported rejection count is increased. Also, the connecting client is disconnected.

swf_verification_matches

A counter of the total number of matches. When an authentic SWF verification credential is presented, this number increases. There may be more than one match per connection.

swf_verification_remote_misses

A counter of the proxy/remote server process’s missed SWF verification attempts. Whenever a proxy/remote server receives a SWF verification attempt it looks to its local cache for valid SWF verification. If it does not locate a match it logs a remote miss and defers to the origin to answer the verification attempt.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP

If the call succeeds, it returns XML with the following structure:

 <result>   <level></level>   <code></code>   <timestamp></timestamp>   <data></data>  </result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

 <result>   <level></level>   <code></code>   <description></description>   <timestamp></timestamp>  </result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy