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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


class OperationalStates(str, Enum):
    NONE = 'None'
    STARTING = 'Starting'
    RUNNING = 'Running'
    STOPPING = 'Stopping'
    STOPPED = 'Stopped'
    RESTARTING = 'Restarting'
    DELETING = 'Deleting'
    UNKNOWN = 'Unknown'


# @Api(Description="Get deployment operational state")
# @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(OperationalStates), StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDeploymentOperationalState(IBaseRequest, IHasId, IHasTenantName, IGet):
    """
    Get deployment operational state
    """

    # @ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
    id: Optional[str] = None

    # @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    # @Validate(Validator="NotEmpty")
    tenant_name: Optional[str] = None

Python 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"