{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"status()","type":"fn","slug":"status","excerpt":"","body":"Retrieves current configuration and status of the applications that were launched using the given API key.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var status = rollAppCloud.status();\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nThis function returns a data object with the following fields:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"status\",\n    \"1-0\": \"quotas\",\n    \"2-0\": \"usedQuotas\",\n    \"3-0\": \"usedAppSlots\",\n    \"4-0\": \"runningSessions\",\n    \"0-1\": \"`True`, if status retrieval was successful\",\n    \"1-1\": \"maximum number of app slots available with this API key. Grouped by size\",\n    \"2-1\": \"number of app slots currently in use. Grouped by size\",\n    \"3-1\": \"total number of app slots currently in use\",\n    \"4-1\": \"list of currently running applications along with data about them\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\nInformation returned about the running applications:\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"sessionId\",\n    \"0-1\": \"unique ID of the session\",\n    \"1-0\": \"appAlias\",\n    \"1-1\": \"alias (identifier) of the application running in this session\",\n    \"2-0\": \"registeredDts\",\n    \"2-1\": \"timestamp of when the session was started\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\nHere is a sample response to the `status()` call:\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"usedQuotas\\\": {\\n        \\\"xs\\\": 1,\\n        \\\"s\\\": 0,\\n        \\\"m\\\": 0,\\n        \\\"l\\\": 0,\\n        \\\"xl\\\": 0\\n    },\\n    \\\"runningSessions\\\": [\\n        {\\n            \\\"sessionId\\\": \\\"71105bcb-6eba-4fcd-80da-77f84866cd15\\\",\\n            \\\"registeredDts\\\": \\\"2019-04-01T00:25:50.653000\\\",\\n            \\\"appAlias\\\": \\\"localc\\\"\\n        }\\n    ],\\n    \\\"quotas\\\": {\\n        \\\"xl\\\": 3,\\n        \\\"m\\\": 3,\\n        \\\"l\\\": 3,\\n        \\\"s\\\": 3,\\n        \\\"xs\\\": 3\\n    },\\n    \\\"success\\\": true,\\n    \\\"usedAppSlots\\\": 1\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ca0dadfa32b57002085ca8f","project":"54523fec04160008005b1cc8","version":{"version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ca0d9153101e9005122599a","5ca0d9153101e9005122599b","5ca0d9153101e9005122599c"],"_id":"5ca0d9153101e900512259aa","project":"54523fec04160008005b1cc8","__v":0,"forked_from":"57b557f0d3092517007cfac3","createdAt":"2016-08-18T06:38:40.018Z","releaseDate":"2016-08-18T06:38:40.018Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cloud App JavaScript API","slug":"cloud-app-javascript-api","order":9999,"from_sync":false,"reference":false,"_id":"5ca0d9153101e9005122599c","project":"54523fec04160008005b1cc8","version":"5ca0d9153101e900512259aa","createdAt":"2017-09-22T09:26:20.780Z","__v":0},"user":"54523f0604160008005b1cc0","createdAt":"2019-03-31T15:21:03.946Z","__v":0}
Retrieves current configuration and status of the applications that were launched using the given API key. [block:code] { "codes": [ { "code": "var status = rollAppCloud.status();", "language": "javascript" } ] } [/block] This function returns a data object with the following fields: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "status", "1-0": "quotas", "2-0": "usedQuotas", "3-0": "usedAppSlots", "4-0": "runningSessions", "0-1": "`True`, if status retrieval was successful", "1-1": "maximum number of app slots available with this API key. Grouped by size", "2-1": "number of app slots currently in use. Grouped by size", "3-1": "total number of app slots currently in use", "4-1": "list of currently running applications along with data about them" }, "cols": 2, "rows": 5 } [/block] Information returned about the running applications: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "sessionId", "0-1": "unique ID of the session", "1-0": "appAlias", "1-1": "alias (identifier) of the application running in this session", "2-0": "registeredDts", "2-1": "timestamp of when the session was started" }, "cols": 2, "rows": 3 } [/block] Here is a sample response to the `status()` call: [block:code] { "codes": [ { "code": "{\n \"usedQuotas\": {\n \"xs\": 1,\n \"s\": 0,\n \"m\": 0,\n \"l\": 0,\n \"xl\": 0\n },\n \"runningSessions\": [\n {\n \"sessionId\": \"71105bcb-6eba-4fcd-80da-77f84866cd15\",\n \"registeredDts\": \"2019-04-01T00:25:50.653000\",\n \"appAlias\": \"localc\"\n }\n ],\n \"quotas\": {\n \"xl\": 3,\n \"m\": 3,\n \"l\": 3,\n \"s\": 3,\n \"xs\": 3\n },\n \"success\": true,\n \"usedAppSlots\": 1\n}", "language": "json" } ] } [/block]