CoreService

<back to all web services

GetDeploymentOperationalState

Deployment - CRUD

Get deployment operational state

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/deployments/{Id}/operationalstateGets a deployments operational state
GET/deployments/{Id}/operationalstateGets a deployments operational state
"use strict";
/** @typedef {'None'|'Starting'|'Running'|'Stopping'|'Stopped'|'Restarting'|'Deleting'|'Unknown'} */
export var OperationalStates;
(function (OperationalStates) {
    OperationalStates["None"] = "None"
    OperationalStates["Starting"] = "Starting"
    OperationalStates["Running"] = "Running"
    OperationalStates["Stopping"] = "Stopping"
    OperationalStates["Stopped"] = "Stopped"
    OperationalStates["Restarting"] = "Restarting"
    OperationalStates["Deleting"] = "Deleting"
    OperationalStates["Unknown"] = "Unknown"
})(OperationalStates || (OperationalStates = {}));
export class GetDeploymentOperationalState {
    /** @param {{id?:string,tenantName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    tenantName;
}

JavaScript GetDeploymentOperationalState DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/deployments/{Id}/operationalstate HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

"None"