GetEnvironmentState

Returns the status of the specified environment, including details about each machine in the environment.

Request URL

view source
print?
GET  https://use.cloudshare.com/API/v2/Env/GetEnvironmentState?envId=<env>&UserApiId=<id>&token=<token>&timestamp=<time>&HMAC=<signature>

Parameters

envId The unique id for the environment.
Example: I5ADJ4VCMBTB

Response example

view source
print?
{
    "data": {
    "data": {
        "available_actions": {
            "add_vms": true,
            "delete_vm": true,
            "reboot_vm": false,
            "resume_environment": true,
            "revert_environment": true,
            "revert_vm": true,
            "take_snapshot": false
        },
        "blueprint": "A linux environment",
        "description": "  CloudShare Pro environment",
        "envId": "V0MDPUQHHN1A",
        "envToken": "VQbE1o1IBQK6B633_UFGog2",
        "environmentPolicy": null,
        "expirationTime": "Wed, 18 Dec 2013 22:00:00 GMT",
        "invitationAllowed": true,
        "licenseValid": "Valid",
        "name": "A linux environment",
        "organization": null,
        "owner": "jsmith@company.com",
        "project": null,
        "resources": {
            "cpu_in_use": 2,
            "cpu_qouta": 10,
            "disk_size_in_use_mb": 32768,
            "disk_size_qouta_mb": 307200,
            "total_memory_in_use_mb": 1024,
            "total_memory_qouta_mb": 8192
        },
        "snapshot": "snap1",
        "status_code": 2,
        "status_text": "Not ready",
        "view_url": "https://use.cloudshare.com/Pro/Environment.mvc/View/VQbE1o1IBQK6B633_UFGog2",
        "vms": [
            {
                "FQDN": null,
                "IP": null,
                "description": "OS: Ubuntu 10.04 Server Spec: 16 GB HD / 0.5 GB RAM",
                "image_url": "https://use.cloudshare.com/ImageHandler.ashx?GyPhdz_F-lBotCNA-kS5MQ2",
                "name": "Ubuntu 10.04 Server",
                "os": "Linux",
                "password": null,
                "progress": 100,
                "status_code": 2,
                "status_text": "Not ready",
                "url": "https://use.cloudshare.com/Pro/Machine.mvc/Show?machineToken=Xk9EgwQaAYxrdv5MMbFAIQ2",
                "username": "sysadmin",
                "vmId": "TY1QYMZHQM4B",
                "vmToken": "Xk9EgwQaAYxrdv5MMbFAIQ2",
                "webAccessUrl": null
            },
            {
                "FQDN": null,
                "IP": null,
                "description": "OS: Ubuntu 10.04 Server Spec: 16 GB HD / 0.5 GB RAM",
                "image_url": "https://use.cloudshare.com/ImageHandler.ashx?GyPhdz_F-lBotCNA-kS5MQ2",
                "name": "Ubuntu 10.04 Server (1)",
                "os": "Linux",
                "password": null,
                "progress": 100,
                "status_code": 2,
                "status_text": "Not ready",
                "url": "https://use.cloudshare.com/Pro/Machine.mvc/Show?machineToken=3L_yk1QWEHE_FvfZ8zb1pQ2",
                "username": "sysadmin",
                "vmId": "EP40Y4W1CDNB",
                "vmToken": "3L_yk1QWEHE_FvfZ8zb1pQ2",
                "webAccessUrl": null
            }
        ]
    },
    "remaining_api_calls": 99987,
    "status_additional_data": null,
    "status_code": "0x20000",
    "status_text": "Success"
}

The response includes details for the environment, as well as details for each machine that is part of the environment.

Details for the environment include: name, expiration date, license status, Blueprints, snapshots.

Details for the machines include: name, IP address, running status, URL.