Skip to content

Latest commit

 

History

History
2821 lines (1956 loc) · 93 KB

api.md

File metadata and controls

2821 lines (1956 loc) · 93 KB
Raw

Singularity REST API

Version: 0.4.2-SNAPSHOT

Endpoints:

  • /api/deploys - Manages Singularity Deploys for existing requests
  • /api/history - Manages historical data for tasks, requests, and deploys.
  • /api/logs - Manages Singularity task logs stored in S3.
  • /api/racks - Manages Singularity racks.
  • /api/requests - Manages Singularity Requests, the parent object for any deployed task
  • /api/sandbox - Provides a proxy to Mesos sandboxes.
  • /api/slaves - Manages Singularity slaves.
  • /api/state - Provides information about the current state of Singularity.
  • /api/tasks - Manages Singularity tasks.
  • /api/test - Misc testing endpoints.
  • /api/webhooks - Manages Singularity webhooks.

Models:

Endpoints

/api/deploys

Overview

Manages Singularity Deploys for existing requests

GET /api/deploys/pending

Retrieve the list of current pending deploys

Parameters
  • No parameters
Response

List[SingularityPendingDeploy]

Errors
Status Code Reason Response Model
- - -

DELETE /api/deploys/deploy/{deployId}/request/{requestId}

Cancel a pending deployment (best effort - the deploy may still succeed or fail)

Parameters

path

Parameter Required Description Data Type
requestId true The Singularity Request Id from which the deployment is removed. string
deployId true The Singularity Deploy Id that should be removed. string
query
Parameter Required Description Data Type
user false The user which executes the delete request. string
Response

SingularityRequestParent

Errors
Status Code Reason Response Model
400 Deploy is not in the pending state pending or is not not present -

POST /api/deploys

Start a new deployment for a Request

Parameters

body

Parameter Required Description Data Type
body true SingularityDeployRequest
Response

SingularityRequestParent

Errors
Status Code Reason Response Model
400 Deploy object is invalid -
409 A current deploy is in progress. It may be canceled by calling DELETE -

/api/history

Overview

Manages historical data for tasks, requests, and deploys.

GET /api/history/task/{taskId}

Retrieve the history for a specific task.

Parameters

path

Parameter Required Description Data Type
taskId true Task ID to look up string
Response

SingularityTaskHistory

Errors
Status Code Reason Response Model
- - -

GET /api/history/requests/search

Search for requests.

Parameters

query

Parameter Required Description Data Type
requestIdLike false Request ID prefix to search for string
count false Maximum number of items to return int
page false Which page of items to view int
Response

List[string]

Errors
Status Code Reason Response Model
- - -

GET /api/history/request/{requestId}/tasks/active

Retrieve the history for all active tasks of a specific request.

Parameters

path

Parameter Required Description Data Type
requestId true Request ID to look up string
Response

List[SingularityTaskIdHistory]

Errors
Status Code Reason Response Model
- - -

GET /api/history/request/{requestId}/tasks

Retrieve the history for all tasks of a specific request.

Parameters

path

Parameter Required Description Data Type
requestId true Request ID to look up string
query
Parameter Required Description Data Type
count false Maximum number of items to return int
page false Which page of items to view int
Response

List[SingularityTaskIdHistory]

Errors
Status Code Reason Response Model
- - -

GET /api/history/request/{requestId}/requests

Parameters

path

Parameter Required Description Data Type
requestId true Request ID to look up string
query
Parameter Required Description Data Type
count false Naximum number of items to return int
page false Which page of items to view int
Response

List[SingularityRequestHistory]

Errors
Status Code Reason Response Model
- - -

GET /api/history/request/{requestId}/deploys

Parameters

path

Parameter Required Description Data Type
requestId true Request ID to look up string
query
Parameter Required Description Data Type
count false Maximum number of items to return int
page false Which page of items to view int
Response

List[SingularityDeployHistory]

Errors
Status Code Reason Response Model
- - -

GET /api/history/request/{requestId}/deploy/{deployId}

Retrieve the history for a specific deploy.

Parameters

path

Parameter Required Description Data Type
requestId true Request ID for deploy string
deployId true Deploy ID string
Response

SingularityDeployHistory

Errors
Status Code Reason Response Model
- - -

/api/logs

Overview

Manages Singularity task logs stored in S3.

GET /api/logs/task/{taskId}

Retrieve the list of logs stored in S3 for a specific task.

Parameters

path

Parameter Required Description Data Type
taskId true The task ID to search for string
Response

List[SingularityS3Log]

Errors
Status Code Reason Response Model
- - -

GET /api/logs/request/{requestId}/deploy/{deployId}

Retrieve the list of logs stored in S3 for a specific deploy.

Parameters

path

Parameter Required Description Data Type
requestId true The request ID to search for string
deployId true The deploy ID to search for string
Response

List[SingularityS3Log]

Errors
Status Code Reason Response Model
- - -

GET /api/logs/request/{requestId}

Retrieve the list of logs stored in S3 for a specific request.

Parameters

path

Parameter Required Description Data Type
requestId true The request ID to search for string
Response

List[SingularityS3Log]

Errors
Status Code Reason Response Model
- - -

/api/racks

Overview

Manages Singularity racks.

POST /api/racks/rack/{rackId}/decommission

Begin decommissioning a specific active rack

Parameters

path

Parameter Required Description Data Type
rackId true Active rack ID string
query
Parameter Required Description Data Type
user false User requesting the decommisioning string
Response
Errors
Status Code Reason Response Model
- - -

POST /api/racks/rack/{rackId}/activate

Activate a decomissioning rack, canceling decomission without erasing history

Parameters

path

Parameter Required Description Data Type
rackId true Active rackId string
query
Parameter Required Description Data Type
user false User requesting the activate string
Response
Errors
Status Code Reason Response Model
- - -

GET /api/racks/rack/{rackId}

Retrieve the history of a given rack

Parameters

path

Parameter Required Description Data Type
rackId true Rack ID string
Response

List[SingularityMachineStateHistoryUpdate]

Errors
Status Code Reason Response Model
- - -

DELETE /api/racks/rack/{rackId}

Remove a known rack, erasing history. This operation will cancel decomissioning of racks

Parameters

path

Parameter Required Description Data Type
rackId true Rack ID string
Response
Errors
Status Code Reason Response Model
- - -

GET /api/racks/

Retrieve the list of all known racks, optionally filtering by a particular state

Parameters

query

Parameter Required Description Data Type
state false Optionally specify a particular state to filter racks by string
Response

List[SingularityRack]

Errors
Status Code Reason Response Model
- - -

/api/requests

Overview

Manages Singularity Requests, the parent object for any deployed task

POST /api/requests/request/{requestId}/unpause

Unpause a Singularity Request, scheduling new tasks immediately

Parameters

path

Parameter Required Description Data Type
requestId true The request ID to unpause string
query
Parameter Required Description Data Type
user false Username of the person requesting the unpause string
Response

SingularityRequestParent

Errors
Status Code Reason Response Model
409 Request is not paused -

POST /api/requests/request/{requestId}/run

Schedule a one-off or scheduled Singularity request for immediate execution.

Parameters

path

Parameter Required Description Data Type
requestId true The request ID to run string
query
Parameter Required Description Data Type
user false Username of the person requesting the execution string
body
Parameter Required Description Data Type
body false Additional command line arguments to append to the task List[string]
Response

SingularityRequestParent

Errors
Status Code Reason Response Model
400 Singularity Request is not scheduled or one-off -

POST /api/requests/request/{requestId}/pause

Pause a Singularity request, future tasks will not run until it is manually unpaused. API can optionally choose to kill existing tasks

Parameters

path

Parameter Required Description Data Type
requestId true The request ID to pause string
query
Parameter Required Description Data Type
user false Username of the person requesting the pause string
body
Parameter Required Description Data Type
body false Pause Request Options SingularityPauseRequest
Response

SingularityRequestParent

Errors
Status Code Reason Response Model
409 Request is already paused or being cleaned -

PUT /api/requests/request/{requestId}/instances

Scale the number of instances up or down for a specific Request

Parameters

path

Parameter Required Description Data Type
requestId true The Request ID to scale string
query
Parameter Required Description Data Type
user false Username of the person requesting the scale string
body
Parameter Required Description Data Type
body false Object to hold number of instances to request SingularityRequestInstances
Response

SingularityRequest

Errors
Status Code Reason Response Model
400 Posted object did not match Request ID -
404 No Request with that ID -

POST /api/requests/request/{requestId}/bounce

Bounce a specific Singularity request. A bounce launches replacement task(s), and then kills the original task(s) if the replacement(s) are healthy.

Parameters

path

Parameter Required Description Data Type
requestId true The request ID to bounce string
query
Parameter Required Description Data Type
user false Username of the person requesting the bounce string
Response

SingularityRequestParent

Errors
Status Code Reason Response Model
- - -

GET /api/requests/request/{requestId}

Retrieve a specific Request by ID

Parameters

path

Parameter Required Description Data Type
requestId true Request ID string
Response

SingularityRequestParent

Errors
Status Code Reason Response Model
404 No Request with that ID -

DELETE /api/requests/request/{requestId}

Delete a specific Request by ID and return the deleted Request

Parameters

path

Parameter Required Description Data Type
requestId true The request ID to delete. string
query
Parameter Required Description Data Type
user false Username of the person requesting the delete string
Response

SingularityRequest

Errors
Status Code Reason Response Model
404 No Request with that ID -

GET /api/requests/queued/pending

Retrieve the list of pending requests

Parameters
  • No parameters
Response

List[SingularityPendingRequest]

Errors
Status Code Reason Response Model
- - -

GET /api/requests/queued/cleanup

Retrieve the list of requests being cleaned up

Parameters
  • No parameters
Response

List[SingularityRequestCleanup]

Errors
Status Code Reason Response Model
- - -

GET /api/requests/paused

Retrieve the list of paused requests

Parameters
  • No parameters
Response

List[SingularityRequestParent]

Errors
Status Code Reason Response Model
- - -

GET /api/requests/finished

Retreive the list of finished requests (Scheduled requests which have exhausted their schedules)

Parameters
  • No parameters
Response

List[SingularityRequestParent]

Errors
Status Code Reason Response Model
- - -

GET /api/requests/cooldown

Retrieve the list of requests in system cooldown

Parameters
  • No parameters
Response

List[SingularityRequestParent]

Errors
Status Code Reason Response Model
- - -

GET /api/requests/active

Retrieve the list of active requests

Parameters
  • No parameters
Response

List[SingularityRequestParent]

Errors
Status Code Reason Response Model
- - -

GET /api/requests

Retrieve the list of all requests

Parameters
  • No parameters
Response

List[SingularityRequestParent]

Errors
Status Code Reason Response Model
- - -

POST /api/requests

Create or update a Singularity Request

Parameters

query

Parameter Required Description Data Type
user false Username of the person requesting to create or update string
body
Parameter Required Description Data Type
body false The Singularity request to create or update SingularityRequest
Response

SingularityRequestParent

Errors
Status Code Reason Response Model
400 Request object is invalid -
409 Request object is being cleaned. Try again shortly -

/api/sandbox

Overview

Provides a proxy to Mesos sandboxes.

GET /api/sandbox/{taskId}/read

Retrieve part of the contents of a file in a specific task's sandbox.

Parameters

path

Parameter Required Description Data Type
taskId true The task ID of the sandbox to read from string
query
Parameter Required Description Data Type
path false The path to the file to be read string
grep false Optional string to grep for string
offset false Byte offset to start reading from long
length false Maximum number of bytes to read long
Response

MesosFileChunkObject

Errors
Status Code Reason Response Model
- - -

GET /api/sandbox/{taskId}/browse

Retrieve information about a specific task's sandbox.

Parameters

path

Parameter Required Description Data Type
taskId true The task ID to browse string
query
Parameter Required Description Data Type
path false The path to browse from string
Response

SingularitySandbox

Errors
Status Code Reason Response Model
- - -

/api/slaves

Overview

Manages Singularity slaves.

POST /api/slaves/slave/{slaveId}/decommission

Begin decommissioning a specific active slave

Parameters

path

Parameter Required Description Data Type
slaveId true Active slaveId string
query
Parameter Required Description Data Type
user false User requesting the decommisioning string
Response
Errors
Status Code Reason Response Model
- - -

POST /api/slaves/slave/{slaveId}/activate

Activate a decomissioning slave, canceling decomission without erasing history

Parameters

path

Parameter Required Description Data Type
slaveId true Active slaveId string
query
Parameter Required Description Data Type
user false User requesting the activate string
Response
Errors
Status Code Reason Response Model
- - -

GET /api/slaves/slave/{slaveId}

Retrieve the history of a given slave

Parameters

path

Parameter Required Description Data Type
slaveId true Slave ID string
Response

List[SingularityMachineStateHistoryUpdate]

Errors
Status Code Reason Response Model
- - -

DELETE /api/slaves/slave/{slaveId}

Remove a known slave, erasing history. This operation will cancel decomissioning of the slave

Parameters

path

Parameter Required Description Data Type
slaveId true Active SlaveId string
Response
Errors
Status Code Reason Response Model
- - -

GET /api/slaves/

Retrieve the list of all known slaves, optionally filtering by a particular state

Parameters

query

Parameter Required Description Data Type
state false Optionally specify a particular state to filter slaves by string
Response

List[SingularitySlave]

Errors
Status Code Reason Response Model
- - -

/api/state

Overview

Provides information about the current state of Singularity.

GET /api/state/requests/under-provisioned

Retrieve the list of under-provisioned request IDs.

Parameters

query

Parameter Required Description Data Type
skipCache false boolean
Response

List[string]

Errors
Status Code Reason Response Model
- - -

GET /api/state/requests/over-provisioned

Retrieve the list of over-provisioned request IDs.

Parameters

query

Parameter Required Description Data Type
skipCache false boolean
Response

List[string]

Errors
Status Code Reason Response Model
- - -

GET /api/state

Retrieve information about the current state of Singularity.

Parameters

query

Parameter Required Description Data Type
skipCache false boolean
includeRequestIds false boolean
Response

SingularityState

Errors
Status Code Reason Response Model
- - -

/api/tasks

Overview

Manages Singularity tasks.

GET /api/tasks/task/{taskId}/statistics

Retrieve statistics about a specific active task.

Parameters

path

Parameter Required Description Data Type
taskId true string
Response

MesosTaskStatisticsObject

Errors
Status Code Reason Response Model
- - -

GET /api/tasks/task/{taskId}

Retrieve information about a specific active task.

Parameters

path

Parameter Required Description Data Type
taskId true string
Response

SingularityTask

Errors
Status Code Reason Response Model
- - -

DELETE /api/tasks/task/{taskId}

Kill a specific active task.

Parameters

path

Parameter Required Description Data Type
taskId true string
query
Parameter Required Description Data Type
user false string
Response

SingularityTaskCleanupResult

Errors
Status Code Reason Response Model
- - -

GET /api/tasks/scheduled/task/{pendingTaskId}

Retrieve information about a pending task.

Parameters

path

Parameter Required Description Data Type
pendingTaskId true string
Response

SingularityTaskRequest

Errors
Status Code Reason Response Model
- - -

GET /api/tasks/scheduled/request/{requestId}

Retrieve list of scheduled tasks for a specific request.

Parameters

path

Parameter Required Description Data Type
requestId true string
Response

List[SingularityTaskRequest]

Errors
Status Code Reason Response Model
- - -

GET /api/tasks/scheduled/ids

Retrieve list of scheduled task IDs.

Parameters
  • No parameters
Response

List[SingularityPendingTaskId]

Errors
Status Code Reason Response Model
- - -

GET /api/tasks/scheduled

Retrieve list of scheduled tasks.

Parameters
  • No parameters
Response

List[SingularityTaskRequest]

Errors
Status Code Reason Response Model
- - -

GET /api/tasks/lbcleanup

Retrieve the list of tasks being cleaned from load balancers.

Parameters
  • No parameters
Response

List[SingularityTaskId]

Errors
Status Code Reason Response Model
- - -

GET /api/tasks/cleaning

Retrieve the list of cleaning tasks.

Parameters
  • No parameters
Response

List[SingularityTaskCleanup]

Errors
Status Code Reason Response Model
- - -

GET /api/tasks/active/slave/{slaveId}

Retrieve list of active tasks on a specific slave.

Parameters

path

Parameter Required Description Data Type
slaveId true string
Response

List[SingularityTask]

Errors
Status Code Reason Response Model
- - -

GET /api/tasks/active

Retrieve the list of active tasks.

Parameters
  • No parameters
Response

List[SingularityTask]

Errors
Status Code Reason Response Model
- - -

/api/test

Overview

Misc testing endpoints.

POST /api/test/stop

Stop the Mesos scheduler driver.

Parameters
  • No parameters
Response
Errors
Status Code Reason Response Model
- - -

POST /api/test/start

Start the Mesos scheduler driver.

Parameters
  • No parameters
Response
Errors
Status Code Reason Response Model
- - -

POST /api/test/scheduler/statusUpdate/{taskId}/{taskState}

Force an update for a specific task.

Parameters

path

Parameter Required Description Data Type
taskId true string
taskState true string
Response
Errors
Status Code Reason Response Model
- - -

POST /api/test/notleader

Make this instanceo of Singularity believe it's lost leadership.

Parameters
  • No parameters
Response
Errors
Status Code Reason Response Model
- - -

POST /api/test/leader

Make this instance of Singularity believe it's elected leader.

Parameters
  • No parameters
Response
Errors
Status Code Reason Response Model
- - -

POST /api/test/abort

Abort the Mesos scheduler driver.

Parameters
  • No parameters
Response
Errors
Status Code Reason Response Model
- - -

/api/webhooks

Overview

Manages Singularity webhooks.

DELETE /api/webhooks/{webhookId}

Delete a specific webhook.

Parameters

path

Parameter Required Description Data Type
webhookId true string
Response

string

Errors
Status Code Reason Response Model
- - -

GET /api/webhooks/task/{webhookId}

Retrieve a list of queued task updates for a specific webhook.

Parameters

path

Parameter Required Description Data Type
webhookId true string
Response

List[SingularityTaskHistoryUpdate]

Errors
Status Code Reason Response Model
- - -

GET /api/webhooks/request/{webhookId}

Retrieve a list of queued request updates for a specific webhook.

Parameters

path

Parameter Required Description Data Type
webhookId true string
Response

List[SingularityRequestHistory]

Errors
Status Code Reason Response Model
- - -

GET /api/webhooks/deploy/{webhookId}

Retrieve a list of queued deploy updates for a specific webhook.

Parameters

path

Parameter Required Description Data Type
webhookId true string
Response

List[SingularityDeployUpdate]

Errors
Status Code Reason Response Model
- - -

GET /api/webhooks

Retrieve a list of active webhooks.

Parameters
  • No parameters
Response

List[SingularityWebhook]

Errors
Status Code Reason Response Model
- - -

POST /api/webhooks

Add a new webhook.

Parameters

body

Parameter Required Description Data Type
body false SingularityWebhook
Response

string

Errors
Status Code Reason Response Model
- - -

Data Types

ByteString

name type required description
validUtf8 boolean optional
empty boolean optional

CommandInfo

name type required description
defaultInstanceForType CommandInfo optional
urisOrBuilderList [List[? extends org.apache.mesos.Protos$CommandInfo$URIOrBuilder]](#model-List[? extends org.apache.mesos.Protos$CommandInfo$URIOrBuilder]) optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$CommandInfo> optional
argumentsCount int optional
urisCount int optional
argumentsList Array[string] optional
containerOrBuilder ContainerInfoOrBuilder optional
container ContainerInfo optional
user string optional
initialized boolean optional
value string optional
environment Environment optional
userBytes ByteString optional
shell boolean optional
serializedSize int optional
urisList List[URI] optional
allFields Map[FieldDescriptor,Object] optional
environmentOrBuilder EnvironmentOrBuilder optional
descriptorForType Descriptor optional
unknownFields UnknownFieldSet optional
valueBytes ByteString optional
initializationErrorString string optional

CommandInfoOrBuilder

name type required description
urisOrBuilderList [List[? extends org.apache.mesos.Protos$CommandInfo$URIOrBuilder]](#model-List[? extends org.apache.mesos.Protos$CommandInfo$URIOrBuilder]) optional
urisCount int optional
argumentsCount int optional
argumentsList Array[string] optional
containerOrBuilder ContainerInfoOrBuilder optional
container ContainerInfo optional
user string optional
value string optional
environment Environment optional
userBytes ByteString optional
shell boolean optional
urisList List[URI] optional
environmentOrBuilder EnvironmentOrBuilder optional
valueBytes ByteString optional

ContainerInfo

name type required description
defaultInstanceForType ContainerInfo optional
type Type optional Allowable values: DOCKER, MESOS
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$ContainerInfo> optional
hostname string optional
dockerOrBuilder DockerInfoOrBuilder optional
initialized boolean optional
volumesCount int optional
serializedSize int optional
volumesList List[Volume] optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
hostnameBytes ByteString optional
volumesOrBuilderList [List[? extends org.apache.mesos.Protos$VolumeOrBuilder]](#model-List[? extends org.apache.mesos.Protos$VolumeOrBuilder]) optional
docker DockerInfo optional
unknownFields UnknownFieldSet optional
initializationErrorString string optional

ContainerInfoOrBuilder

name type required description
type Type optional Allowable values: DOCKER, MESOS
hostname string optional
dockerOrBuilder DockerInfoOrBuilder optional
volumesCount int optional
volumesList List[Volume] optional
hostnameBytes ByteString optional
volumesOrBuilderList [List[? extends org.apache.mesos.Protos$VolumeOrBuilder]](#model-List[? extends org.apache.mesos.Protos$VolumeOrBuilder]) optional
docker DockerInfo optional

Descriptor

name type required description
enumTypes List[EnumDescriptor] optional
fullName string optional
containingType Descriptor optional
file FileDescriptor optional
extensions List[FieldDescriptor] optional
options MessageOptions optional
fields List[FieldDescriptor] optional
name string optional
index int optional
nestedTypes List[Descriptor] optional

DockerInfo

name type required description
portMappingsOrBuilderList [List[? extends org.apache.mesos.Protos$ContainerInfo$DockerInfo$PortMappingOrBuilder]](#model-List[? extends org.apache.mesos.Protos$ContainerInfo$DockerInfo$PortMappingOrBuilder]) optional
defaultInstanceForType DockerInfo optional
parametersList List[Parameter] optional
parametersOrBuilderList [List[? extends org.apache.mesos.Protos$ParameterOrBuilder]](#model-List[? extends org.apache.mesos.Protos$ParameterOrBuilder]) optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$ContainerInfo$DockerInfo> optional
imageBytes ByteString optional
initialized boolean optional
privileged boolean optional
portMappingsCount int optional
parametersCount int optional
serializedSize int optional
network Network optional Allowable values: HOST, BRIDGE, NONE
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
portMappingsList List[PortMapping] optional
image string optional
unknownFields UnknownFieldSet optional
initializationErrorString string optional

DockerInfoOrBuilder

name type required description
portMappingsOrBuilderList [List[? extends org.apache.mesos.Protos$ContainerInfo$DockerInfo$PortMappingOrBuilder]](#model-List[? extends org.apache.mesos.Protos$ContainerInfo$DockerInfo$PortMappingOrBuilder]) optional
parametersOrBuilderList [List[? extends org.apache.mesos.Protos$ParameterOrBuilder]](#model-List[? extends org.apache.mesos.Protos$ParameterOrBuilder]) optional
parametersList List[Parameter] optional
imageBytes ByteString optional
privileged boolean optional
parametersCount int optional
portMappingsCount int optional
network Network optional Allowable values: HOST, BRIDGE, NONE
portMappingsList List[PortMapping] optional
image string optional

EmbeddedArtifact

name type required description
md5sum string optional
filename string optional
name string optional
content Array[byte] optional

Environment

name type required description
defaultInstanceForType Environment optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$Environment> optional
initialized boolean optional
variablesCount int optional
serializedSize int optional
allFields Map[FieldDescriptor,Object] optional
variablesOrBuilderList [List[? extends org.apache.mesos.Protos$Environment$VariableOrBuilder]](#model-List[? extends org.apache.mesos.Protos$Environment$VariableOrBuilder]) optional
variablesList List[Variable] optional
descriptorForType Descriptor optional
initializationErrorString string optional
unknownFields UnknownFieldSet optional

EnvironmentOrBuilder

name type required description
variablesCount int optional
variablesOrBuilderList [List[? extends org.apache.mesos.Protos$Environment$VariableOrBuilder]](#model-List[? extends org.apache.mesos.Protos$Environment$VariableOrBuilder]) optional
variablesList List[Variable] optional

ExecutorData

name type required description
loggingExtraFields Map[string,string] optional
successfulExitCodes Array[int] optional
s3Artifacts Array[S3Artifact] optional
embeddedArtifacts Array[EmbeddedArtifact] optional
runningSentinel string optional
externalArtifacts Array[ExternalArtifact] optional
user string optional
extraCmdLineArgs Array[string] optional
loggingTag string optional
sigKillProcessesAfterMillis long optional
maxTaskThreads int optional
cmd string optional

ExecutorID

name type required description
defaultInstanceForType ExecutorID optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$ExecutorID> optional
value string optional
initialized boolean optional
serializedSize int optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
initializationErrorString string optional
valueBytes ByteString optional
unknownFields UnknownFieldSet optional

ExecutorIDOrBuilder

name type required description
value string optional
valueBytes ByteString optional

ExecutorInfo

name type required description
commandOrBuilder CommandInfoOrBuilder optional
defaultInstanceForType ExecutorInfo optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$ExecutorInfo> optional
resourcesOrBuilderList [List[? extends org.apache.mesos.Protos$ResourceOrBuilder]](#model-List[? extends org.apache.mesos.Protos$ResourceOrBuilder]) optional
data ByteString optional
source string optional
containerOrBuilder ContainerInfoOrBuilder optional
container ContainerInfo optional
executorId ExecutorID optional
initialized boolean optional
name string optional
nameBytes ByteString optional
sourceBytes ByteString optional
frameworkId FrameworkID optional
command CommandInfo optional
frameworkIdOrBuilder FrameworkIDOrBuilder optional
executorIdOrBuilder ExecutorIDOrBuilder optional
serializedSize int optional
resourcesList List[Resource] optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
resourcesCount int optional
unknownFields UnknownFieldSet optional
initializationErrorString string optional

ExecutorInfoOrBuilder

name type required description
commandOrBuilder CommandInfoOrBuilder optional
resourcesOrBuilderList [List[? extends org.apache.mesos.Protos$ResourceOrBuilder]](#model-List[? extends org.apache.mesos.Protos$ResourceOrBuilder]) optional
data ByteString optional
source string optional
containerOrBuilder ContainerInfoOrBuilder optional
container ContainerInfo optional
executorId ExecutorID optional
name string optional
nameBytes ByteString optional
frameworkId FrameworkID optional
command CommandInfo optional
sourceBytes ByteString optional
frameworkIdOrBuilder FrameworkIDOrBuilder optional
executorIdOrBuilder ExecutorIDOrBuilder optional
resourcesList List[Resource] optional
resourcesCount int optional

ExternalArtifact

name type required description
md5sum string optional
url string optional
filename string optional
filesize long optional
name string optional

FileDescriptor

name type required description
enumTypes List[EnumDescriptor] optional
publicDependencies List[FileDescriptor] optional
extensions List[FieldDescriptor] optional
services List[ServiceDescriptor] optional
options FileOptions optional
messageTypes List[Descriptor] optional
name string optional
dependencies List[FileDescriptor] optional
package string optional

FileOptions

name type required description
defaultInstanceForType FileOptions optional
javaMultipleFiles boolean optional
optimizeFor OptimizeMode optional Allowable values: SPEED, CODE_SIZE, LITE_RUNTIME
parserForType com.google.protobuf.Parser<com.google.protobuf.DescriptorProtos$FileOptions> optional
javaPackageBytes ByteString optional
goPackageBytes ByteString optional
uninterpretedOptionCount int optional
javaGenericServices boolean optional
javaOuterClassnameBytes ByteString optional
initialized boolean optional
javaOuterClassname string optional
serializedSize int optional
pyGenericServices boolean optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
uninterpretedOptionList List[UninterpretedOption] optional
javaPackage string optional
goPackage string optional
uninterpretedOptionOrBuilderList [List[? extends com.google.protobuf.DescriptorProtos$UninterpretedOptionOrBuilder]](#model-List[? extends com.google.protobuf.DescriptorProtos$UninterpretedOptionOrBuilder]) optional
unknownFields UnknownFieldSet optional
javaGenerateEqualsAndHash boolean optional
initializationErrorString string optional
ccGenericServices boolean optional

FrameworkID

name type required description
defaultInstanceForType FrameworkID optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$FrameworkID> optional
value string optional
initialized boolean optional
serializedSize int optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
initializationErrorString string optional
valueBytes ByteString optional
unknownFields UnknownFieldSet optional

FrameworkIDOrBuilder

name type required description
value string optional
valueBytes ByteString optional

HTTP

name type required description
defaultInstanceForType HTTP optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$HealthCheck$HTTP> optional
pathBytes ByteString optional
initialized boolean optional
serializedSize int optional
statusesCount int optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
path string optional
port int optional
unknownFields UnknownFieldSet optional
statusesList Array[int] optional
initializationErrorString string optional

HTTPOrBuilder

name type required description
pathBytes ByteString optional
statusesCount int optional
port int optional
path string optional
statusesList Array[int] optional

HealthCheck

name type required description
commandOrBuilder CommandInfoOrBuilder optional
defaultInstanceForType HealthCheck optional
gracePeriodSeconds double optional
httpOrBuilder HTTPOrBuilder optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$HealthCheck> optional
consecutiveFailures int optional
intervalSeconds double optional
initialized boolean optional
command CommandInfo optional
serializedSize int optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
timeoutSeconds double optional
http HTTP optional
unknownFields UnknownFieldSet optional
delaySeconds double optional
initializationErrorString string optional

HealthCheckOrBuilder

name type required description
commandOrBuilder CommandInfoOrBuilder optional
gracePeriodSeconds double optional
httpOrBuilder HTTPOrBuilder optional
consecutiveFailures int optional
intervalSeconds double optional
command CommandInfo optional
timeoutSeconds double optional
http HTTP optional
delaySeconds double optional

LoadBalancerRequestId

name type required description
requestType LoadBalancerRequestType optional Allowable values: ADD, REMOVE, DEPLOY
attemptNumber int optional
id string optional

MesosFileChunkObject

name type required description
data string optional
offset long optional

MesosTaskStatisticsObject

name type required description
memFileBytes long optional
memLimitBytes long optional
cpusThrottledTimeSecs float optional
cpusSystemTimeSecs float optional
memRssBytes long optional
memAnonBytes long optional
memMappedFileBytes long optional
cpusLimit int optional
timestamp double optional
cpusNrPeriods int optional
cpusUserTimeSecs float optional
cpusNrThrottled int optional

MessageOptions

name type required description
defaultInstanceForType MessageOptions optional
parserForType com.google.protobuf.Parser<com.google.protobuf.DescriptorProtos$MessageOptions> optional
uninterpretedOptionCount int optional
initialized boolean optional
noStandardDescriptorAccessor boolean optional
serializedSize int optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
messageSetWireFormat boolean optional
uninterpretedOptionList List[UninterpretedOption] optional
unknownFields UnknownFieldSet optional
uninterpretedOptionOrBuilderList [List[? extends com.google.protobuf.DescriptorProtos$UninterpretedOptionOrBuilder]](#model-List[? extends com.google.protobuf.DescriptorProtos$UninterpretedOptionOrBuilder]) optional
initializationErrorString string optional

Offer

name type required description
defaultInstanceForType Offer optional
executorIdsOrBuilderList [List[? extends org.apache.mesos.Protos$ExecutorIDOrBuilder]](#model-List[? extends org.apache.mesos.Protos$ExecutorIDOrBuilder]) optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$Offer> optional
slaveIdOrBuilder SlaveIDOrBuilder optional
executorIdsCount int optional
resourcesOrBuilderList [List[? extends org.apache.mesos.Protos$ResourceOrBuilder]](#model-List[? extends org.apache.mesos.Protos$ResourceOrBuilder]) optional
executorIdsList List[ExecutorID] optional
hostname string optional
attributesCount int optional
initialized boolean optional
attributesList List[Attribute] optional
idOrBuilder OfferIDOrBuilder optional
frameworkId FrameworkID optional
frameworkIdOrBuilder FrameworkIDOrBuilder optional
serializedSize int optional
resourcesList List[Resource] optional
slaveId SlaveID optional
allFields Map[FieldDescriptor,Object] optional
hostnameBytes ByteString optional
descriptorForType Descriptor optional
attributesOrBuilderList [List[? extends org.apache.mesos.Protos$AttributeOrBuilder]](#model-List[? extends org.apache.mesos.Protos$AttributeOrBuilder]) optional
unknownFields UnknownFieldSet optional
resourcesCount int optional
id OfferID optional
initializationErrorString string optional

OfferID

name type required description
defaultInstanceForType OfferID optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$OfferID> optional
value string optional
initialized boolean optional
serializedSize int optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
initializationErrorString string optional
valueBytes ByteString optional
unknownFields UnknownFieldSet optional

OfferIDOrBuilder

name type required description
value string optional
valueBytes ByteString optional

S3Artifact

name type required description
s3Bucket string optional
md5sum string optional
filename string optional
filesize long optional
s3ObjectKey string optional
name string optional

SingularityContainerInfo

name type required description
type Type optional Allowable values: DOCKER, MESOS
volumes Array[SingularityVolume] optional
docker SingularityDockerInfo optional

SingularityDeploy

name type required description
customExecutorId string optional Custom Mesos executor id.
resources com.hubspot.mesos.Resources optional Resources required for this deploy.
uris Array[string] optional List of URIs to download before executing the deploy command.
containerInfo SingularityContainerInfo optional Container information for deployment into a container.
arguments Array[string] optional Command arguments.
serviceBasePath string optional The base path for the API exposed by the deploy. Used in conjunction with the Load balancer API.
metadata Map[string,string] optional Map of metadata key/value pairs associated with the deployment.
customExecutorSource string optional Custom Mesos executor source.
healthcheckTimeoutSeconds long optional Health check timeout in seconds.
healthcheckUri string optional Deployment Healthcheck URI.
requestId string required Singularity Request Id which is associated with this deploy.
loadBalancerGroups Array[string] optional List of load balancer groups associated with this deployment.
skipHealthchecksOnDeploy boolean optional Allows skipping of health checks when deploying.
healthcheckIntervalSeconds long optional Health check interval in seconds.
executorData ExecutorData optional Executor specific information
command string optional Command to execute for this deployment.
considerHealthyAfterRunningForSeconds long optional Number of seconds that a service must be healthy to consider the deployment to be successful.
timestamp long optional Deploy timestamp.
loadBalancerOptions Map[string,Object] optional Map (Key/Value) of options for the load balancer.
customExecutorCmd string optional Custom Mesos executor
env Map[string,string] optional Map of environment variable definitions.
version string optional Deploy version
deployHealthTimeoutSeconds long optional Number of seconds that singularity waits for this service to become healthy.
id string required Singularity deploy id.

SingularityDeployHistory

name type required description
deploy SingularityDeploy optional
deployStatistics SingularityDeployStatistics optional
deployResult SingularityDeployResult optional
deployMarker SingularityDeployMarker optional

SingularityDeployMarker

name type required description
user string optional
requestId string optional
timestamp long optional
deployId string optional

SingularityDeployRequest

name type required description
unpauseOnSuccessfulDeploy boolean optional If deploy is successful, also unpause the request.
deploy SingularityDeploy required The Singularity deploy object
user string optional User owning this deploy.

SingularityDeployResult

name type required description
lbUpdate SingularityLoadBalancerUpdate optional
deployState DeployState optional Allowable values: SUCCEEDED, FAILED_INTERNAL_STATE, CANCELING, WAITING, OVERDUE, FAILED, CANCELED
message string optional
timestamp long optional

SingularityDeployStatistics

name type required description
lastTaskState ExtendedTaskState optional
numFailures int optional
numTasks int optional
averageRuntimeMillis long optional
lastFinishAt long optional
requestId string optional
deployId string optional
numSequentialRetries int optional
numSuccess int optional
instanceSequentialFailureTimestamps [com.google.common.collect.ListMultimap<java.lang.Integer, java.lang.Long>](#model-com.google.common.collect.ListMultimap<java.lang.Integer, java.lang.Long>) optional

SingularityDeployUpdate

name type required description
deploy SingularityDeploy optional
deployResult SingularityDeployResult optional
eventType DeployEventType optional Allowable values: STARTING, FINISHED
deployMarker SingularityDeployMarker optional

SingularityDockerInfo

name type required description
privileged boolean optional
network Network optional
portMappings Array[SingularityDockerPortMapping] optional
image string optional

SingularityDockerPortMapping

name type required description
hostPort int optional
containerPort int optional
containerPortType SingularityPortMappingType optional Allowable values: LITERAL, FROM_OFFER
protocol string optional
hostPortType SingularityPortMappingType optional Allowable values: LITERAL, FROM_OFFER

SingularityHostState

name type required description
hostAddress string optional
hostname string optional
driverStatus string optional
master boolean optional
mesosMaster string optional
uptime long optional
millisSinceLastOffer long optional

SingularityLoadBalancerUpdate

name type required description
loadBalancerState BaragonRequestState optional Allowable values: UNKNOWN, FAILED, WAITING, SUCCESS, CANCELING, CANCELED
loadBalancerRequestId LoadBalancerRequestId optional
uri string optional
method LoadBalancerMethod optional Allowable values: PRE_ENQUEUE, ENQUEUE, CHECK_STATE, CANCEL
message string optional
timestamp long optional

SingularityMachineStateHistoryUpdate

name type required description
state MachineState optional Allowable values: MISSING_ON_STARTUP, ACTIVE, STARTING_DECOMMISSION, DECOMMISSIONING, DECOMMISSIONED, DEAD
user string optional
timestamp long optional
objectId string optional

SingularityPauseRequest

name type required description
user string optional
killTasks boolean optional

SingularityPendingDeploy

name type required description
currentDeployState DeployState optional Allowable values: SUCCEEDED, FAILED_INTERNAL_STATE, CANCELING, WAITING, OVERDUE, FAILED, CANCELED
lastLoadBalancerUpdate SingularityLoadBalancerUpdate optional
deployMarker SingularityDeployMarker optional

SingularityPendingRequest

name type required description
user string optional
requestId string optional
timestamp long optional
deployId string optional
cmdLineArgsList Array[string] optional
pendingType PendingType optional Allowable values: IMMEDIATE, ONEOFF, BOUNCE, NEW_DEPLOY, UNPAUSED, RETRY, UPDATED_REQUEST, DECOMISSIONED_SLAVE_OR_RACK, TASK_DONE, STARTUP

SingularityPendingTask

name type required description
pendingTaskId SingularityPendingTaskId optional
user string optional
cmdLineArgsList Array[string] optional

SingularityPendingTaskId

name type required description
nextRunAt long optional
requestId string optional
deployId string optional
pendingType PendingType optional Allowable values: IMMEDIATE, ONEOFF, BOUNCE, NEW_DEPLOY, UNPAUSED, RETRY, UPDATED_REQUEST, DECOMISSIONED_SLAVE_OR_RACK, TASK_DONE, STARTUP
instanceNo int optional
createdAt long optional
id string optional

SingularityRack

name type required description
currentState SingularityMachineStateHistoryUpdate optional
firstSeenAt long optional
id string optional

SingularityRequest

name type required description
schedule string optional
rackAffinity Array[string] optional
daemon boolean optional
slavePlacement SlavePlacement optional
rackSensitive boolean optional
owners Array[string] optional
requestType RequestType optional Allowable values: SERVICE, WORKER, SCHEDULED, ON_DEMAND, RUN_ONCE
quartzSchedule string optional
scheduledExpectedRuntimeMillis long optional
loadBalanced boolean optional
numRetriesOnFailure int optional
killOldNonLongRunningTasksAfterMillis long optional
instances int optional
scheduleType ScheduleType optional
id string optional

SingularityRequestCleanup

name type required description
requestId string optional
user string optional
killTasks boolean optional
cleanupType RequestCleanupType optional Allowable values: DELETING, PAUSING, BOUNCE
timestamp long optional
deployId string optional

SingularityRequestDeployState

name type required description
pendingDeploy SingularityDeployMarker optional
requestId string optional
activeDeploy SingularityDeployMarker optional

SingularityRequestHistory

name type required description
user string optional
request SingularityRequest optional
eventType RequestHistoryType optional Allowable values: CREATED, UPDATED, DELETED, PAUSED, UNPAUSED, ENTERED_COOLDOWN, EXITED_COOLDOWN, FINISHED, DEPLOYED_TO_UNPAUSE
createdAt long optional

SingularityRequestInstances

name type required description
instances int optional
id string optional

SingularityRequestParent

name type required description
state RequestState optional Allowable values: ACTIVE, DELETED, PAUSED, SYSTEM_COOLDOWN, FINISHED, DEPLOYING_TO_UNPAUSE
pendingDeploy SingularityDeploy optional
activeDeploy SingularityDeploy optional
request SingularityRequest optional
pendingDeployState SingularityPendingDeploy optional
requestDeployState SingularityRequestDeployState optional

SingularitySandbox

name type required description
slaveHostname string optional Hostname of tasks's slave
files Array[SingularitySandboxFile] optional List of files inside sandbox
currentDirectory string optional Current directory
fullPathToRoot string optional Full path to the root of the Mesos task sandbox

SingularitySandboxFile

name type required description
size long optional File size (in bytes)
mode string optional File mode
mtime long optional Last modified time
name string optional Filename

SingularitySlave

name type required description
currentState SingularityMachineStateHistoryUpdate optional
host string optional Slave hostname
rackId string optional Slave rack ID
firstSeenAt long optional
id string optional

SingularityState

name type required description
activeRacks int optional
decomissioningRacks int optional
activeSlaves int optional
generatedAt long optional
pausedRequests int optional
activeTasks int optional
lbCleanupTasks int optional
overProvisionedRequestIds Array[string] optional
cleaningRequests int optional
deadSlaves int optional
lateTasks int optional
overProvisionedRequests int optional
decommissioningSlaves int optional
unknownRacks int optional
numDeploys int optional
cleaningTasks int optional
unknownSlaves int optional
activeRequests int optional
futureTasks int optional
decommissioningRacks int optional
finishedRequests int optional
deadRacks int optional
pendingRequests int optional
maxTaskLag long optional
cooldownRequests int optional
hostStates Array[SingularityHostState] optional
allRequests int optional
underProvisionedRequests int optional
decomissioningSlaves int optional
oldestDeploy long optional
scheduledTasks int optional
underProvisionedRequestIds Array[string] optional

SingularityTask

name type required description
taskId SingularityTaskId optional
taskRequest SingularityTaskRequest optional
offer Offer optional
mesosTask TaskInfo optional

SingularityTaskCleanup

name type required description
taskId SingularityTaskId optional
user string optional
cleanupType TaskCleanupType optional Allowable values: USER_REQUESTED, DECOMISSIONING, SCALING_DOWN, BOUNCING, DEPLOY_FAILED, NEW_DEPLOY_SUCCEEDED, DEPLOY_CANCELED, UNHEALTHY_NEW_TASK, OVERDUE_NEW_TASK
timestamp long optional

SingularityTaskCleanupResult

name type required description
result SingularityCreateResult optional Allowable values: CREATED, EXISTED
task SingularityTask optional

SingularityTaskHealthcheckResult

name type required description
taskId SingularityTaskId optional
durationMillis long optional
errorMessage string optional
statusCode int optional
timestamp long optional
responseBody string optional

SingularityTaskHistory

name type required description
directory string optional
task SingularityTask optional
healthcheckResults Array[SingularityTaskHealthcheckResult] optional
loadBalancerUpdates Array[SingularityLoadBalancerUpdate] optional
taskUpdates Array[SingularityTaskHistoryUpdate] optional

SingularityTaskHistoryUpdate

name type required description
taskId SingularityTaskId optional
statusMessage string optional
taskState ExtendedTaskState optional Allowable values: TASK_LAUNCHED, TASK_STAGING, TASK_STARTING, TASK_RUNNING, TASK_CLEANING, TASK_FINISHED, TASK_FAILED, TASK_KILLED, TASK_LOST, TASK_LOST_WHILE_DOWN
timestamp long optional

SingularityTaskId

name type required description
requestId string optional
host string optional
deployId string optional
rackId string optional
instanceNo int optional
startedAt long optional
id string optional

SingularityTaskIdHistory

name type required description
taskId SingularityTaskId optional
updatedAt long optional
lastTaskState ExtendedTaskState optional

SingularityTaskRequest

name type required description
deploy SingularityDeploy optional
request SingularityRequest optional
pendingTask SingularityPendingTask optional

SingularityVolume

name type required description
hostPath string optional
containerPath string optional
mode Mode optional Allowable values: RW, RO

SingularityWebhook

name type required description
type WebhookType optional Webhook type. Allowable values: TASK, REQUEST, DEPLOY
uri string optional URI to POST to.
user string optional User that created webhook.
timestamp long optional
id string optional Unique ID for webhook.

SlaveID

name type required description
defaultInstanceForType SlaveID optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$SlaveID> optional
value string optional
initialized boolean optional
serializedSize int optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
initializationErrorString string optional
valueBytes ByteString optional
unknownFields UnknownFieldSet optional

SlaveIDOrBuilder

name type required description
value string optional
valueBytes ByteString optional

TaskID

name type required description
defaultInstanceForType TaskID optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$TaskID> optional
value string optional
initialized boolean optional
serializedSize int optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
initializationErrorString string optional
valueBytes ByteString optional
unknownFields UnknownFieldSet optional

TaskIDOrBuilder

name type required description
value string optional
valueBytes ByteString optional

TaskInfo

name type required description
commandOrBuilder CommandInfoOrBuilder optional
defaultInstanceForType TaskInfo optional
taskId TaskID optional
taskIdOrBuilder TaskIDOrBuilder optional
parserForType com.google.protobuf.Parser<org.apache.mesos.Protos$TaskInfo> optional
slaveIdOrBuilder SlaveIDOrBuilder optional
resourcesOrBuilderList [List[? extends org.apache.mesos.Protos$ResourceOrBuilder]](#model-List[? extends org.apache.mesos.Protos$ResourceOrBuilder]) optional
data ByteString optional
executor ExecutorInfo optional
containerOrBuilder ContainerInfoOrBuilder optional
executorOrBuilder ExecutorInfoOrBuilder optional
container ContainerInfo optional
healthCheckOrBuilder HealthCheckOrBuilder optional
initialized boolean optional
name string optional
nameBytes ByteString optional
command CommandInfo optional
healthCheck HealthCheck optional
serializedSize int optional
resourcesList List[Resource] optional
slaveId SlaveID optional
allFields Map[FieldDescriptor,Object] optional
descriptorForType Descriptor optional
unknownFields UnknownFieldSet optional
resourcesCount int optional
initializationErrorString string optional

UnknownFieldSet

name type required description
defaultInstanceForType UnknownFieldSet optional
serializedSizeAsMessageSet int optional
parserForType Parser optional
initialized boolean optional
serializedSize int optional