| Required role: | TenantReader |
| GET | /api/deployments/{Id}/operationalstate | Gets a deployments operational state | |
|---|---|---|---|
| GET | /deployments/{Id}/operationalstate | Gets a deployments operational state |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get deployment operational state
*/
@Api(Description="Get deployment operational state")
@ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=OperationalStates::class, StatusCode=200)
open class GetDeploymentOperationalState : IBaseRequest, IHasId, IHasTenantName, IGet
{
@ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
override var id:UUID? = null
@ApiMember(DataType="string", IsRequired=true, ParameterType="header")
@Validate(Validator="NotEmpty")
override var tenantName:String? = null
}
enum class OperationalStates
{
None,
Starting,
Running,
Stopping,
Stopped,
Restarting,
Deleting,
Unknown,
}
Kotlin 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
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"