[API Specifications] Service

Service status

Visibility: internal; Auth: not required

Request:

GET /v1/status

Response:

200 OK
Content-Type: application/JSON

{
    "Name": "DeviceSimulation",
    "Status": "OK:...msg...|ERROR:...msg...",
    "CurrentTime": "datetime ...",
    "StartTime": "datetime ...",
    "UpTime": "timespan ...",
    "UID": "779e748b-fc97-4eb4-adcd-2fbe51df619c",
    "Properties": {
        "Simulation": "on|off"
    },
    "Dependencies": {
        "IoTHubManager": "OK:...msg...|ERROR:...msg...",
        "Storage": "OK:...msg...|ERROR:...msg..."
    },
    "$metadata": {
        "$type": "Status;v1",
        "$uri": "/v1/status"
    }
}

• Status: the message is optional
• UpTime: value specific to the process running, i.e. in case of multiple deployments each instance has a different uptime
• UID: a unique value in each instance, used mostly for logging correlation
• Properties: used only for debugging, free form entries
• Dependencies: health status of the internal dependencies, values used only for debugging