status()

Retrieves current configuration and status of the applications that were launched using the given API key.

JavaScript

var status = rollAppCloud.status();

This function returns a data object with the following fields:

Field	Description
status	True, if status retrieval was successful
quotas	maximum number of app slots available with this API key. Grouped by size
usedQuotas	number of app slots currently in use. Grouped by size
usedAppSlots	total number of app slots currently in use
runningSessions	list of currently running applications along with data about them

Information returned about the running applications:

Field	Description
sessionId	unique ID of the session
appAlias	alias (identifier) of the application running in this session
registeredDts	timestamp of when the session was started

Here is a sample response to the status() call:

JSON

{
    "usedQuotas": {
        "xs": 1,
        "s": 0,
        "m": 0,
        "l": 0,
        "xl": 0
    },
    "runningSessions": [
        {
            "sessionId": "71105bcb-6eba-4fcd-80da-77f84866cd15",
            "registeredDts": "2019-04-01T00:25:50.653000",
            "appAlias": "localc"
        }
    ],
    "quotas": {
        "xl": 3,
        "m": 3,
        "l": 3,
        "s": 3,
        "xs": 3
    },
    "success": true,
    "usedAppSlots": 1
}