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:
Manages Singularity Deploys for existing requests
Retrieve the list of current pending deploys
List[SingularityPendingDeploy]
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)
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
SingularityRequestParent
Status Code
Reason
Response Model
400
Deploy is not in the pending state pending or is not not present
-
Start a new deployment for a Request
body
SingularityRequestParent
Status Code
Reason
Response Model
400
Deploy object is invalid
-
409
A current deploy is in progress. It may be canceled by calling DELETE
-
Manages historical data for tasks, requests, and deploys.
GET /api/history/task/{taskId}
Retrieve the history for a specific task.
path
Parameter
Required
Description
Data Type
taskId
true
Task ID to look up
string
SingularityTaskHistory
Status Code
Reason
Response Model
-
-
-
GET /api/history/requests/search
Search for requests.
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
List[string]
Status Code
Reason
Response Model
-
-
-
GET /api/history/request/{requestId}/tasks/active
Retrieve the history for all active tasks of a specific request.
path
Parameter
Required
Description
Data Type
requestId
true
Request ID to look up
string
List[SingularityTaskIdHistory]
Status Code
Reason
Response Model
-
-
-
GET /api/history/request/{requestId}/tasks
Retrieve the history for all tasks of a specific request.
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
List[SingularityTaskIdHistory]
Status Code
Reason
Response Model
-
-
-
GET /api/history/request/{requestId}/requests
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
List[SingularityRequestHistory]
Status Code
Reason
Response Model
-
-
-
GET /api/history/request/{requestId}/deploys
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
List[SingularityDeployHistory]
Status Code
Reason
Response Model
-
-
-
GET /api/history/request/{requestId}/deploy/{deployId}
Retrieve the history for a specific deploy.
path
Parameter
Required
Description
Data Type
requestId
true
Request ID for deploy
string
deployId
true
Deploy ID
string
SingularityDeployHistory
Status Code
Reason
Response Model
-
-
-
Manages Singularity task logs stored in S3.
GET /api/logs/task/{taskId}
Retrieve the list of logs stored in S3 for a specific task.
path
Parameter
Required
Description
Data Type
taskId
true
The task ID to search for
string
List[SingularityS3Log]
Status Code
Reason
Response Model
-
-
-
GET /api/logs/request/{requestId}/deploy/{deployId}
Retrieve the list of logs stored in S3 for a specific deploy.
path
Parameter
Required
Description
Data Type
requestId
true
The request ID to search for
string
deployId
true
The deploy ID to search for
string
List[SingularityS3Log]
Status Code
Reason
Response Model
-
-
-
GET /api/logs/request/{requestId}
Retrieve the list of logs stored in S3 for a specific request.
path
Parameter
Required
Description
Data Type
requestId
true
The request ID to search for
string
List[SingularityS3Log]
Status Code
Reason
Response Model
-
-
-
Manages Singularity racks.
POST /api/racks/rack/{rackId}/decommission
Begin decommissioning a specific active rack
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
Status Code
Reason
Response Model
-
-
-
POST /api/racks/rack/{rackId}/activate
Activate a decomissioning rack, canceling decomission without erasing history
path
Parameter
Required
Description
Data Type
rackId
true
Active rackId
string
query
Parameter
Required
Description
Data Type
user
false
User requesting the activate
string
Status Code
Reason
Response Model
-
-
-
GET /api/racks/rack/{rackId}
Retrieve the history of a given rack
path
Parameter
Required
Description
Data Type
rackId
true
Rack ID
string
List[SingularityMachineStateHistoryUpdate]
Status Code
Reason
Response Model
-
-
-
DELETE /api/racks/rack/{rackId}
Remove a known rack, erasing history. This operation will cancel decomissioning of racks
path
Parameter
Required
Description
Data Type
rackId
true
Rack ID
string
Status Code
Reason
Response Model
-
-
-
Retrieve the list of all known racks, optionally filtering by a particular state
query
Parameter
Required
Description
Data Type
state
false
Optionally specify a particular state to filter racks by
string
List[SingularityRack]
Status Code
Reason
Response Model
-
-
-
Manages Singularity Requests, the parent object for any deployed task
POST /api/requests/request/{requestId}/unpause
Unpause a Singularity Request, scheduling new tasks immediately
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
SingularityRequestParent
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.
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]
SingularityRequestParent
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
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
SingularityRequestParent
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
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
SingularityRequest
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.
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
SingularityRequestParent
Status Code
Reason
Response Model
-
-
-
GET /api/requests/request/{requestId}
Retrieve a specific Request by ID
path
Parameter
Required
Description
Data Type
requestId
true
Request ID
string
SingularityRequestParent
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
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
SingularityRequest
Status Code
Reason
Response Model
404
No Request with that ID
-
GET /api/requests/queued/pending
Retrieve the list of pending requests
List[SingularityPendingRequest]
Status Code
Reason
Response Model
-
-
-
GET /api/requests/queued/cleanup
Retrieve the list of requests being cleaned up
List[SingularityRequestCleanup]
Status Code
Reason
Response Model
-
-
-
Retrieve the list of paused requests
List[SingularityRequestParent]
Status Code
Reason
Response Model
-
-
-
GET /api/requests/finished
Retreive the list of finished requests (Scheduled requests which have exhausted their schedules)
List[SingularityRequestParent]
Status Code
Reason
Response Model
-
-
-
GET /api/requests/cooldown
Retrieve the list of requests in system cooldown
List[SingularityRequestParent]
Status Code
Reason
Response Model
-
-
-
Retrieve the list of active requests
List[SingularityRequestParent]
Status Code
Reason
Response Model
-
-
-
Retrieve the list of all requests
List[SingularityRequestParent]
Status Code
Reason
Response Model
-
-
-
Create or update a Singularity Request
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
SingularityRequestParent
Status Code
Reason
Response Model
400
Request object is invalid
-
409
Request object is being cleaned. Try again shortly
-
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.
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
MesosFileChunkObject
Status Code
Reason
Response Model
-
-
-
GET /api/sandbox/{taskId}/browse
Retrieve information about a specific task's sandbox.
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
SingularitySandbox
Status Code
Reason
Response Model
-
-
-
Manages Singularity slaves.
POST /api/slaves/slave/{slaveId}/decommission
Begin decommissioning a specific active slave
path
Parameter
Required
Description
Data Type
slaveId
true
Active slaveId
string
query
Parameter
Required
Description
Data Type
user
false
User requesting the decommisioning
string
Status Code
Reason
Response Model
-
-
-
POST /api/slaves/slave/{slaveId}/activate
Activate a decomissioning slave, canceling decomission without erasing history
path
Parameter
Required
Description
Data Type
slaveId
true
Active slaveId
string
query
Parameter
Required
Description
Data Type
user
false
User requesting the activate
string
Status Code
Reason
Response Model
-
-
-
GET /api/slaves/slave/{slaveId}
Retrieve the history of a given slave
path
Parameter
Required
Description
Data Type
slaveId
true
Slave ID
string
List[SingularityMachineStateHistoryUpdate]
Status Code
Reason
Response Model
-
-
-
DELETE /api/slaves/slave/{slaveId}
Remove a known slave, erasing history. This operation will cancel decomissioning of the slave
path
Parameter
Required
Description
Data Type
slaveId
true
Active SlaveId
string
Status Code
Reason
Response Model
-
-
-
Retrieve the list of all known slaves, optionally filtering by a particular state
query
Parameter
Required
Description
Data Type
state
false
Optionally specify a particular state to filter slaves by
string
List[SingularitySlave]
Status Code
Reason
Response Model
-
-
-
Provides information about the current state of Singularity.
GET /api/state/requests/under-provisioned
Retrieve the list of under-provisioned request IDs.
query
Parameter
Required
Description
Data Type
skipCache
false
boolean
List[string]
Status Code
Reason
Response Model
-
-
-
GET /api/state/requests/over-provisioned
Retrieve the list of over-provisioned request IDs.
query
Parameter
Required
Description
Data Type
skipCache
false
boolean
List[string]
Status Code
Reason
Response Model
-
-
-
Retrieve information about the current state of Singularity.
query
Parameter
Required
Description
Data Type
skipCache
false
boolean
includeRequestIds
false
boolean
SingularityState
Status Code
Reason
Response Model
-
-
-
Manages Singularity tasks.
GET /api/tasks/task/{taskId}/statistics
Retrieve statistics about a specific active task.
path
Parameter
Required
Description
Data Type
taskId
true
string
MesosTaskStatisticsObject
Status Code
Reason
Response Model
-
-
-
GET /api/tasks/task/{taskId}
Retrieve information about a specific active task.
path
Parameter
Required
Description
Data Type
taskId
true
string
SingularityTask
Status Code
Reason
Response Model
-
-
-
DELETE /api/tasks/task/{taskId}
Kill a specific active task.
path
Parameter
Required
Description
Data Type
taskId
true
string
query
Parameter
Required
Description
Data Type
user
false
string
SingularityTaskCleanupResult
Status Code
Reason
Response Model
-
-
-
GET /api/tasks/scheduled/task/{pendingTaskId}
Retrieve information about a pending task.
path
Parameter
Required
Description
Data Type
pendingTaskId
true
string
SingularityTaskRequest
Status Code
Reason
Response Model
-
-
-
GET /api/tasks/scheduled/request/{requestId}
Retrieve list of scheduled tasks for a specific request.
path
Parameter
Required
Description
Data Type
requestId
true
string
List[SingularityTaskRequest]
Status Code
Reason
Response Model
-
-
-
GET /api/tasks/scheduled/ids
Retrieve list of scheduled task IDs.
List[SingularityPendingTaskId]
Status Code
Reason
Response Model
-
-
-
Retrieve list of scheduled tasks.
List[SingularityTaskRequest]
Status Code
Reason
Response Model
-
-
-
Retrieve the list of tasks being cleaned from load balancers.
List[SingularityTaskId]
Status Code
Reason
Response Model
-
-
-
Retrieve the list of cleaning tasks.
List[SingularityTaskCleanup]
Status Code
Reason
Response Model
-
-
-
GET /api/tasks/active/slave/{slaveId}
Retrieve list of active tasks on a specific slave.
path
Parameter
Required
Description
Data Type
slaveId
true
string
List[SingularityTask]
Status Code
Reason
Response Model
-
-
-
Retrieve the list of active tasks.
List[SingularityTask]
Status Code
Reason
Response Model
-
-
-
Misc testing endpoints.
Stop the Mesos scheduler driver.
Status Code
Reason
Response Model
-
-
-
Start the Mesos scheduler driver.
Status Code
Reason
Response Model
-
-
-
POST /api/test/scheduler/statusUpdate/{taskId}/{taskState}
Force an update for a specific task.
path
Parameter
Required
Description
Data Type
taskId
true
string
taskState
true
string
Status Code
Reason
Response Model
-
-
-
Make this instanceo of Singularity believe it's lost leadership.
Status Code
Reason
Response Model
-
-
-
Make this instance of Singularity believe it's elected leader.
Status Code
Reason
Response Model
-
-
-
Abort the Mesos scheduler driver.
Status Code
Reason
Response Model
-
-
-
Manages Singularity webhooks.
DELETE /api/webhooks/{webhookId}
Delete a specific webhook.
path
Parameter
Required
Description
Data Type
webhookId
true
string
string
Status Code
Reason
Response Model
-
-
-
GET /api/webhooks/task/{webhookId}
Retrieve a list of queued task updates for a specific webhook.
path
Parameter
Required
Description
Data Type
webhookId
true
string
List[SingularityTaskHistoryUpdate]
Status Code
Reason
Response Model
-
-
-
GET /api/webhooks/request/{webhookId}
Retrieve a list of queued request updates for a specific webhook.
path
Parameter
Required
Description
Data Type
webhookId
true
string
List[SingularityRequestHistory]
Status Code
Reason
Response Model
-
-
-
GET /api/webhooks/deploy/{webhookId}
Retrieve a list of queued deploy updates for a specific webhook.
path
Parameter
Required
Description
Data Type
webhookId
true
string
List[SingularityDeployUpdate]
Status Code
Reason
Response Model
-
-
-
Retrieve a list of active webhooks.
List[SingularityWebhook]
Status Code
Reason
Response Model
-
-
-
Add a new webhook.
body
string
Status Code
Reason
Response Model
-
-
-
name
type
required
description
validUtf8
boolean
optional
empty
boolean
optional
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
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
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
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
name
type
required
description
md5sum
string
optional
filename
string
optional
name
string
optional
content
Array[byte]
optional
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
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
name
type
required
description
value
string
optional
valueBytes
ByteString
optional
name
type
required
description
md5sum
string
optional
url
string
optional
filename
string
optional
filesize
long
optional
name
string
optional
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
name
type
required
description
value
string
optional
valueBytes
ByteString
optional
name
type
required
description
pathBytes
ByteString
optional
statusesCount
int
optional
port
int
optional
path
string
optional
statusesList
Array[int]
optional
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
name
type
required
description
requestType
LoadBalancerRequestType
optional
Allowable values: ADD, REMOVE, DEPLOY
attemptNumber
int
optional
id
string
optional
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
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
name
type
required
description
value
string
optional
valueBytes
ByteString
optional
name
type
required
description
s3Bucket
string
optional
md5sum
string
optional
filename
string
optional
filesize
long
optional
s3ObjectKey
string
optional
name
string
optional
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.
name
type
required
description
user
string
optional
requestId
string
optional
timestamp
long
optional
deployId
string
optional
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.
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
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
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
name
type
required
description
user
string
optional
killTasks
boolean
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
name
type
required
description
pendingTaskId
SingularityPendingTaskId
optional
user
string
optional
cmdLineArgsList
Array[string]
optional
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
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
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
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
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
name
type
required
description
currentState
SingularityMachineStateHistoryUpdate
optional
host
string
optional
Slave hostname
rackId
string
optional
Slave rack ID
firstSeenAt
long
optional
id
string
optional
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
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
SingularityTaskHealthcheckResult
name
type
required
description
taskId
SingularityTaskId
optional
durationMillis
long
optional
errorMessage
string
optional
statusCode
int
optional
timestamp
long
optional
responseBody
string
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
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
name
type
required
description
hostPath
string
optional
containerPath
string
optional
mode
Mode
optional
Allowable values: RW, RO
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.
name
type
required
description
value
string
optional
valueBytes
ByteString
optional
name
type
required
description
value
string
optional
valueBytes
ByteString
optional
name
type
required
description
defaultInstanceForType
UnknownFieldSet
optional
serializedSizeAsMessageSet
int
optional
parserForType
Parser
optional
initialized
boolean
optional
serializedSize
int
optional