Operator HTTP API
Mesos 1.0.0 added experimental support for v1 Operator HTTP API.
Overview
Both masters and agents provide the /api/v1 endpoint as the base URL for performing operator-related operations.
Similar to the Scheduler and Executor HTTP APIs, the operator endpoints only accept HTTP POST requests. The request body should be encoded in JSON (Content-Type: application/json) or Protobuf (Content-Type: application/x-protobuf).
For requests that Mesos can answer synchronously and immediately, an HTTP response will be sent with status 200 OK, possibly including a response body encoded in JSON or Protobuf. The encoding depends on the Accept header present in the request (the default encoding is JSON). Responses will be gzip compressed if the Accept-Encoding header is set to "gzip".
For requests that require asynchronous processing (e.g., RESERVE_RESOURCES), an HTTP response will be sent with status 202 Accepted. For requests that result in a stream of events (SUBSCRIBE), a streaming HTTP response with RecordIO encoding is sent. Currently, gzip compression is not supported for streaming responses.
Master API
This API contains all the calls accepted by the master. The canonical source of this information is master.proto (NOTE: The protobuf definitions are subject to change before the beta API is finalized). These calls are typically made by human operators, tooling or services (e.g., Mesos WebUI). While schedulers can make these calls as well, schedulers are expected to use the Scheduler HTTP API.
Calls To Master And Responses
Below are the example calls to master that result in synchronous responses from the API.
GET_HEALTH
This call retrieves the health status of master.
GET_HEALTH HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
“type”: “GET_HEALTH”
}
GET_HEALTH HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_HEALTH",
"get_health": {
"healthy": true
}
}
GET_FLAGS
This call retrieves the master's overall flag configuration.
GET_FLAGS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
“type”: “GET_FLAGS”
}
GET_FLAGS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_FLAGS",
"get_flags": {
"flags": [
{
"name": "acls",
"value": ""
},
{
"name": "agent_ping_timeout",
"value": "15secs"
},
{
"name": "agent_reregister_timeout",
"value": "10mins"
},
{
"name": "allocation_interval",
"value": "1secs"
},
{
"name": "allocator",
"value": "HierarchicalDRF"
},
{
"name": "authenticate_agents",
"value": "true"
},
{
"name": "authenticate_frameworks",
"value": "true"
},
{
"name": "authenticate_http_frameworks",
"value": "true"
},
{
"name": "authenticate_http_readonly",
"value": "true"
},
{
"name": "authenticate_http_readwrite",
"value": "true"
},
{
"name": "authenticators",
"value": "crammd5"
},
{
"name": "authorizers",
"value": "local"
},
{
"name": "credentials",
"value": "/tmp/directory/credentials"
},
{
"name": "framework_sorter",
"value": "drf"
},
{
"name": "help",
"value": "false"
},
{
"name": "hostname_lookup",
"value": "true"
},
{
"name": "http_authenticators",
"value": "basic"
},
{
"name": "http_framework_authenticators",
"value": "basic"
},
{
"name": "initialize_driver_logging",
"value": "true"
},
{
"name": "log_auto_initialize",
"value": "true"
},
{
"name": "logbufsecs",
"value": "0"
},
{
"name": "logging_level",
"value": "INFO"
},
{
"name": "max_agent_ping_timeouts",
"value": "5"
},
{
"name": "max_completed_frameworks",
"value": "50"
},
{
"name": "max_completed_tasks_per_framework",
"value": "1000"
},
{
"name": "quiet",
"value": "false"
},
{
"name": "recovery_agent_removal_limit",
"value": "100%"
},
{
"name": "registry",
"value": "replicated_log"
},
{
"name": "registry_fetch_timeout",
"value": "1mins"
},
{
"name": "registry_store_timeout",
"value": "100secs"
},
{
"name": "registry_strict",
"value": "true"
},
{
"name": "root_submissions",
"value": "true"
},
{
"name": "user_sorter",
"value": "drf"
},
{
"name": "version",
"value": "false"
},
{
"name": "webui_dir",
"value": "/usr/local/share/mesos/webui"
},
{
"name": "work_dir",
"value": "/tmp/directory/master"
},
{
"name": "zk_session_timeout",
"value": "10secs"
}
]
}
}
GET_VERSION
This call retrieves the master's version information.
GET_VERSION HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
“type”: “GET_VERSION”
}
GET_VERSION HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
“type”: GET_VERSION,
“get_version”: {
“version_info”: {
"version": "1.0.0",
"build_date": "2016-06-24 23:18:37",
"build_time": 1466810317,
"build_user": "root"
}
}
}
GET_METRICS
This call gives the snapshot of current metrics to the end user. If timeout is
set in the call, it would be used to determine the maximum amount of time the
API will take to respond. If the timeout is exceeded, some metrics may not be
included in the response.
GET_METRICS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"get_metrics": {
"timeout": {
"nanoseconds": 5000000000
}
},
"type": "GET_METRICS"
}
GET_METRICS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_METRICS",
"get_metrics": {
"metrics": [
{
"name": "allocator/event_queue_dispatches",
"value": 1.0
},
{
"name": "master/slaves_active",
"value": 0.0
},
{
"name": "allocator/mesos/resources/cpus/total",
"value": 0.0
},
{
"name": "master/messages_revive_offers",
"value": 0.0
},
{
"name": "allocator/mesos/allocation_runs",
"value": 0.0
},
{
"name": "master/mem_used",
"value": 0.0
},
{
"name": "master/valid_executor_to_framework_messages",
"value": 0.0
},
{
"name": "allocator/mesos/resources/mem/total",
"value": 0.0
},
{
"name": "log/recovered",
"value": 1.0
},
{
"name": "registrar/registry_size_bytes",
"value": 123.0
},
{
"name": "master/slaves_inactive",
"value": 0.0
},
{
"name": "master/messages_unregister_slave",
"value": 0.0
},
{
"name": "master/gpus_total",
"value": 0.0
},
{
"name": "master/disk_revocable_total",
"value": 0.0
},
{
"name": "master/gpus_percent",
"value": 0.0
},
{
"name": "master/mem_revocable_used",
"value": 0.0
},
{
"name": "master/slave_shutdowns_completed",
"value": 0.0
},
{
"name": "master/invalid_status_updates",
"value": 0.0
},
{
"name": "master/slave_removals",
"value": 0.0
},
{
"name": "master/messages_status_update",
"value": 0.0
},
{
"name": "master/messages_framework_to_executor",
"value": 0.0
},
{
"name": "master/cpus_revocable_percent",
"value": 0.0
},
{
"name": "master/recovery_slave_removals",
"value": 0.0
},
{
"name": "master/event_queue_dispatches",
"value": 0.0
},
{
"name": "master/messages_update_slave",
"value": 0.0
},
{
"name": "allocator/mesos/resources/mem/offered_or_allocated",
"value": 0.0
},
{
"name": "master/messages_register_framework",
"value": 0.0
},
{
"name": "master/cpus_percent",
"value": 0.0
},
{
"name": "master/slave_reregistrations",
"value": 0.0
},
{
"name": "master/cpus_revocable_total",
"value": 0.0
},
{
"name": "master/gpus_revocable_total",
"value": 0.0
},
{
"name": "master/valid_status_updates",
"value": 0.0
},
{
"name": "system/load_15min",
"value": 1.25
},
{
"name": "master/event_queue_http_requests",
"value": 0.0
},
{
"name": "master/messages_decline_offers",
"value": 0.0
},
{
"name": "master/tasks_staging",
"value": 0.0
},
{
"name": "master/messages_register_slave",
"value": 0.0
},
{
"name": "allocator/mesos/resources/disk/offered_or_allocated",
"value": 0.0
},
{
"name": "system/mem_free_bytes",
"value": 2320146432.0
},
{
"name": "system/cpus_total",
"value": 4.0
},
{
"name": "master/mem_percent",
"value": 0.0
},
{
"name": "master/event_queue_messages",
"value": 0.0
},
{
"name": "master/messages_reregister_slave",
"value": 0.0
},
{
"name": "master/gpus_used",
"value": 0.0
},
{
"name": "registrar/state_fetch_ms",
"value": 16.787968
},
{
"name": "master/messages_launch_tasks",
"value": 0.0
},
{
"name": "master/gpus_revocable_percent",
"value": 0.0
},
{
"name": "master/disk_percent",
"value": 0.0
},
{
"name": "system/load_1min",
"value": 1.74
},
{
"name": "registrar/queued_operations",
"value": 0.0
},
{
"name": "master/slaves_disconnected",
"value": 0.0
},
{
"name": "master/invalid_status_update_acknowledgements",
"value": 0.0
},
{
"name": "system/load_5min",
"value": 1.65
},
{
"name": "master/tasks_failed",
"value": 0.0
},
{
"name": "master/slave_registrations",
"value": 0.0
},
{
"name": "master/frameworks_connected",
"value": 0.0
},
{
"name": "allocator/mesos/event_queue_dispatches",
"value": 0.0
},
{
"name": "master/messages_executor_to_framework",
"value": 0.0
},
{
"name": "system/mem_total_bytes",
"value": 8057147392.0
},
{
"name": "master/cpus_revocable_used",
"value": 0.0
},
{
"name": "master/tasks_killing",
"value": 0.0
},
{
"name": "allocator/mesos/resources/cpus/offered_or_allocated",
"value": 0.0
},
{
"name": "master/messages_exited_executor",
"value": 0.0
},
{
"name": "master/valid_status_update_acknowledgements",
"value": 0.0
},
{
"name": "master/disk_used",
"value": 0.0
},
{
"name": "master/gpus_revocable_used",
"value": 0.0
},
{
"name": "master/disk_revocable_percent",
"value": 0.0
},
{
"name": "master/mem_revocable_percent",
"value": 0.0
},
{
"name": "master/invalid_executor_to_framework_messages",
"value": 0.0
},
{
"name": "master/slave_shutdowns_scheduled",
"value": 0.0
},
{
"name": "master/slave_removals/reason_registered",
"value": 0.0
},
{
"name": "master/messages_suppress_offers",
"value": 0.0
},
{
"name": "master/uptime_secs",
"value": 0.038900992
},
{
"name": "allocator/mesos/resources/disk/total",
"value": 0.0
},
{
"name": "master/slave_removals/reason_unregistered",
"value": 0.0
},
{
"name": "master/disk_total",
"value": 0.0
},
{
"name": "master/messages_resource_request",
"value": 0.0
},
{
"name": "master/cpus_total",
"value": 0.0
},
{
"name": "master/valid_framework_to_executor_messages",
"value": 0.0
},
{
"name": "master/cpus_used",
"value": 0.0
},
{
"name": "master/slave_removals/reason_unhealthy",
"value": 0.0
},
{
"name": "master/messages_kill_task",
"value": 0.0
},
{
"name": "master/slave_shutdowns_canceled",
"value": 0.0
},
{
"name": "master/messages_deactivate_framework",
"value": 0.0
},
{
"name": "master/messages_unregister_framework",
"value": 0.0
},
{
"name": "master/mem_revocable_total",
"value": 0.0
},
{
"name": "master/messages_reregister_framework",
"value": 0.0
},
{
"name": "master/dropped_messages",
"value": 0.0
},
{
"name": "master/invalid_framework_to_executor_messages",
"value": 0.0
},
{
"name": "master/tasks_error",
"value": 0.0
},
{
"name": "master/tasks_lost",
"value": 0.0
},
{
"name": "master/messages_reconcile_tasks",
"value": 0.0
},
{
"name": "master/tasks_killed",
"value": 0.0
},
{
"name": "master/tasks_finished",
"value": 0.0
},
{
"name": "master/frameworks_inactive",
"value": 0.0
},
{
"name": "master/tasks_running",
"value": 0.0
},
{
"name": "master/tasks_starting",
"value": 0.0
},
{
"name": "registrar/state_store_ms",
"value": 5.55392
},
{
"name": "master/mem_total",
"value": 0.0
},
{
"name": "master/outstanding_offers",
"value": 0.0
},
{
"name": "master/frameworks_active",
"value": 0.0
},
{
"name": "master/messages_authenticate",
"value": 0.0
},
{
"name": "master/disk_revocable_used",
"value": 0.0
},
{
"name": "master/frameworks_disconnected",
"value": 0.0
},
{
"name": "master/slaves_connected",
"value": 0.0
},
{
"name": "master/messages_status_update_acknowledgement",
"value": 0.0
},
{
"name": "master/elected",
"value": 1.0
}
]
}
}
GET_LOGGING_LEVEL
This call retrieves the master's logging level.
GET_LOGGING_LEVEL HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "GET_LOGGING_LEVEL"
}
GET_LOGGING_LEVEL HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_LOGGING_LEVEL",
"get_logging_level": {
"level": 0
}
}
SET_LOGGING_LEVEL
Sets the logging verbosity level for a specified duration for master. Mesos uses glog for logging. The library only uses verbose logging which means nothing will be output unless the verbosity level is set (by default it's 0, libprocess uses levels 1, 2, and 3).
SET_LOGGING_LEVEL HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "SET_LOGGING_LEVEL",
"set_logging_level": {
"duration": {
"nanoseconds": 60000000000
},
"level": 1
}
}
SET_LOGGING_LEVEL HTTP Response:
HTTP/1.1 202 Accepted
LIST_FILES
This call retrieves the file listing for a directory in master.
LIST_FILES HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "LIST_FILES",
"list_files": {
"path": "one/"
}
}
LIST_FILES HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "LIST_FILES",
"list_files": {
"file_infos": [
{
"gid": "root",
"mode": 16877,
"mtime": {
"nanoseconds": 1470820172000000000
},
"nlink": 2,
"path": "one/2",
"size": 4096,
"uid": "root"
},
{
"gid": "root",
"mode": 16877,
"mtime": {
"nanoseconds": 1470820172000000000
},
"nlink": 2,
"path": "one/3",
"size": 4096,
"uid": "root"
},
{
"gid": "root",
"mode": 33188,
"mtime": {
"nanoseconds": 1470820172000000000
},
"nlink": 1,
"path": "one/two",
"size": 3,
"uid": "root"
}
]
}
}
READ_FILE
Reads data from a file. This call takes path of the file to be read in the master, offset to start reading position and length for the maximum number of bytes to read.
READ_FILE HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "READ_FILE",
"read_file": {
"length": 6,
"offset": 1,
"path": "myname"
}
}
READ_FILE HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "READ_FILE",
"read_file": {
"data": "b2R5",
"size": 4
}
}
GET_STATE
This call retrieves the overall cluster state.
GET_STATE HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "GET_STATE"
}
GET_STATE HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_STATE",
"get_state": {
"get_agents": {
"agents": [
{
"active": true,
"agent_info": {
"hostname": "myhost",
"id": {
"value": "628984d0-4213-4140-bcb0-99d7ef46b1df-S0"
},
"port": 34626,
"resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 2.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "disk",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "ports",
"ranges": {
"range": [
{
"begin": 31000,
"end": 32000
}
]
},
"role": "*",
"type": "RANGES"
}
]
},
"pid": "slave(3)@127.0.1.1:34626",
"registered_time": {
"nanoseconds": 1470820172046531840
},
"total_resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 2.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "disk",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "ports",
"ranges": {
"range": [
{
"begin": 31000,
"end": 32000
}
]
},
"role": "*",
"type": "RANGES"
}
],
"version": "1.1.0"
}
]
},
"get_executors": {
"executors": [
{
"agent_id": {
"value": "628984d0-4213-4140-bcb0-99d7ef46b1df-S0"
},
"executor_info": {
"command": {
"shell": true,
"value": ""
},
"executor_id": {
"value": "default"
},
"framework_id": {
"value": "628984d0-4213-4140-bcb0-99d7ef46b1df-0000"
}
}
}
]
},
"get_frameworks": {
"frameworks": [
{
"active": true,
"connected": true,
"framework_info": {
"checkpoint": false,
"failover_timeout": 0.0,
"hostname": "abcdev",
"id": {
"value": "628984d0-4213-4140-bcb0-99d7ef46b1df-0000"
},
"name": "default",
"principal": "my-principal",
"role": "*",
"user": "root"
},
"registered_time": {
"nanoseconds": 1470820172039300864
},
"reregistered_time": {
"nanoseconds": 1470820172039300864
}
}
]
},
"get_tasks": {
"completed_tasks": [
{
"agent_id": {
"value": "628984d0-4213-4140-bcb0-99d7ef46b1df-S0"
},
"executor_id": {
"value": "default"
},
"framework_id": {
"value": "628984d0-4213-4140-bcb0-99d7ef46b1df-0000"
},
"name": "test-task",
"resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 2.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "disk",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "ports",
"ranges": {
"range": [
{
"begin": 31000,
"end": 32000
}
]
},
"role": "*",
"type": "RANGES"
}
],
"state": "TASK_FINISHED",
"status_update_state": "TASK_FINISHED",
"status_update_uuid": "IWjmPnfgQCWxGVlNNwctcg==",
"statuses": [
{
"agent_id": {
"value": "628984d0-4213-4140-bcb0-99d7ef46b1df-S0"
},
"container_status": {
"network_infos": [
{
"ip_addresses": [
{
"ip_address": "127.0.1.1"
}
]
}
]
},
"executor_id": {
"value": "default"
},
"source": "SOURCE_EXECUTOR",
"state": "TASK_RUNNING",
"task_id": {
"value": "eb5cb680-a998-4605-8811-e79db8734c02"
},
"timestamp": 1470820172.07315,
"uuid": "hTaLQ0b5Q1OZuab7QclTKQ=="
},
{
"agent_id": {
"value": "628984d0-4213-4140-bcb0-99d7ef46b1df-S0"
},
"container_status": {
"network_infos": [
{
"ip_addresses": [
{
"ip_address": "127.0.1.1"
}
]
}
]
},
"executor_id": {
"value": "default"
},
"source": "SOURCE_EXECUTOR",
"state": "TASK_FINISHED",
"task_id": {
"value": "eb5cb680-a998-4605-8811-e79db8734c02"
},
"timestamp": 1470820172.09382,
"uuid": "IWjmPnfgQCWxGVlNNwctcg=="
}
],
"task_id": {
"value": "eb5cb680-a998-4605-8811-e79db8734c02"
}
}
]
}
}
}
GET_AGENTS
This call retrieves information about all the agents known to the master.
GET_AGENTS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "GET_AGENTS"
}
GET_AGENTS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{{
"type": "GET_AGENTS",
"get_agents": {
"agents": [
{
"active": true,
"agent_info": {
"hostname": "host",
"id": {
"value": "3669ea49-c3c4-4b13-adee-05b8f9cb2562-S0"
},
"port": 34626,
"resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 2.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "disk",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "ports",
"ranges": {
"range": [
{
"begin": 31000,
"end": 32000
}
]
},
"role": "*",
"type": "RANGES"
}
]
},
"pid": "slave(1)@127.0.1.1:34626",
"registered_time": {
"nanoseconds": 1470820171393027072
},
"total_resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 2.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "disk",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "ports",
"ranges": {
"range": [
{
"begin": 31000,
"end": 32000
}
]
},
"role": "*",
"type": "RANGES"
}
],
"version": "1.1.0"
}
]
}
}
GET_FRAMEWORKS
This call retrieves information about all the frameworks known to the master.
GET_FRAMEWORKS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
“type”: “GET_FRAMEWORKS”
}
GET_FRAMEWORKS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
“type”: “GET_FRAMEWORKS”,
"get_frameworks": {
"frameworks": [
{
"active": true,
"connected": true,
"framework_info": {
"checkpoint": false,
"failover_timeout": 0.0,
"hostname": "myhost",
"id": {
"value": "361be53a-4d1b-42c1-bec3-e3979eff90bd-0000"
},
"name": "default",
"principal": "my-principal",
"role": "*",
"user": "root"
},
"registered_time": {
"nanoseconds": 1470820171578306816
},
"reregistered_time": {
"nanoseconds": 1470820171578306816
}
}
]
}
}
GET_EXECUTORS
Queries about all the executors known to the master.
GET_EXECUTORS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
“type”: “GET_EXECUTORS”
}
GET_EXECUTORS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
“type”: “GET_EXECUTORS”,
"get_executors": {
"executors": [
{
"agent_id": {
"value": "f2ddc41d-6284-405e-8642-34953093140f-S0"
},
"executor_info": {
"command": {
"shell": true,
"value": "exit 1"
},
"executor_id": {
"value": "default"
},
"framework_id": {
"value": "f2ddc41d-6284-405e-8642-34953093140f-0000"
}
}
}
]
}
}
GET_TASKS
Query about all the tasks known to the master.
GET_TASKS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "GET_TASKS"
}
GET_TASKS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_TASKS",
"get_tasks": {
"tasks": [
{
"agent_id": {
"value": "d4bd102f-e25f-46dc-bb5d-8b10bca133d8-S0"
},
"executor_id": {
"value": "default"
},
"framework_id": {
"value": "d4bd102f-e25f-46dc-bb5d-8b10bca133d8-0000"
},
"name": "test",
"resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 2.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "disk",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "ports",
"ranges": {
"range": [
{
"begin": 31000,
"end": 32000
}
]
},
"role": "*",
"type": "RANGES"
}
],
"state": "TASK_RUNNING",
"status_update_state": "TASK_RUNNING",
"status_update_uuid": "ycLTRBo8TjKFTrh4vsBERg==",
"statuses": [
{
"agent_id": {
"value": "d4bd102f-e25f-46dc-bb5d-8b10bca133d8-S0"
},
"container_status": {
"network_infos": [
{
"ip_addresses": [
{
"ip_address": "127.0.1.1"
}
]
}
]
},
"executor_id": {
"value": "default"
},
"source": "SOURCE_EXECUTOR",
"state": "TASK_RUNNING",
"task_id": {
"value": "1"
},
"timestamp": 1470820172.32565,
"uuid": "ycLTRBo8TjKFTrh4vsBERg=="
}
],
"task_id": {
"value": "1"
}
}
]
}
}
GET_ROLES
Query the information about roles.
GET_ROLES HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "GET_ROLES"
}
GET_ROLES HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_ROLES",
"get_roles": {
"roles": [
{
"name": "*",
"weight": 1.0
},
{
"frameworks": [
{
"value": "74bddcbc-4a02-4d64-b291-aed52032055f-0000"
}
],
"name": "role1",
"resources": [
{
"name": "cpus",
"role": "role1",
"scalar": {
"value": 0.5
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "role1",
"scalar": {
"value": 512.0
},
"type": "SCALAR"
},
{
"name": "ports",
"ranges": {
"range": [
{
"begin": 31000,
"end": 31001
}
]
},
"role": "role1",
"type": "RANGES"
},
{
"name": "disk",
"role": "role1",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
}
],
"weight": 2.5
}
]
}
}
GET_WEIGHTS
This call retrieves the information about role weights.
GET_WEIGHTS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
“type”: “GET_WEIGHTS”
}
GET_WEIGHTS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
“type”: “GET_WEIGHTS”,
"get_weights": {
"weight_infos": [
{
"role": "role",
"weight": 2.0
}
]
}
}
UPDATE_WEIGHTS
This call updates weights for specific role. This call takes weight_infos
which needs role value and weight value.
UPDATE_WEIGHTS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "UPDATE_WEIGHTS",
"update_weights": {
"weight_infos": [
{
"role": "role",
"weight": 4.0
}
]
}
}
UPDATE_WEIGHTS HTTP Response:
HTTP/1.1 202 Accepted
GET_MASTER
This call retrieves the information on master.
GET_MASTER HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "GET_MASTER"
}
GET_MASTER HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_MASTER",
"get_master": {
"master_info": {
"address": {
"hostname": "myhost",
"ip": "127.0.1.1",
"port": 34626
},
"hostname": "myhost",
"id": "310ffdac-0b73-408d-acf0-2adcd21cb4b7",
"ip": 16842879,
"pid": "master@127.0.1.1:34626",
"port": 34626,
"version": "1.1.0"
}
}
}
RESERVE_RESOURCES
This call reserve resources dynamically on a specific agent. This call takes
agent_id and resources details like the following.
RESERVE_RESOURCES HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "RESERVE_RESOURCES",
"reserve_resources": {
"agent_id": {
"value": "1557de7d-547c-48db-b5d3-6bef9c9640ef-S0"
},
"resources": [
{
"type": "SCALAR",
"name": "cpus",
"reservation": {
"principal": "my-principal"
},
"role": "role",
"scalar": {
"value": 1.0
}
},
{
"type": "SCALAR",
"name": "mem",
"reservation": {
"principal": "my-principal"
},
"role": "role",
"scalar": {
"value": 512.0
}
}
]
}
}
RESERVE_RESOURCES HTTP Response:
HTTP/1.1 202 Accepted
UNRESERVE_RESOURCES
This call unreserve resources dynamically on a specific agent. This call takes
agent_id and resources details like the following.
UNRESERVE_RESOURCES HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "UNRESERVE_RESOURCES",
"unreserve_resources": {
"agent_id": {
"value": "1557de7d-547c-48db-b5d3-6bef9c9640ef-S0"
},
"resources": [
{
"type": "SCALAR",
"name": "cpus",
"reservation": {
"principal": "my-principal"
},
"role": "role",
"scalar": {
"value": 1.0
}
},
{
"type": "SCALAR",
"name": "mem",
"reservation": {
"principal": "my-principal"
},
"role": "role",
"scalar": {
"value": 512.0
}
}
]
}
}
UNRESERVE_RESOURCES HTTP Response:
HTTP/1.1 202 Accepted
CREATE_VOLUMES
This call create persistent volumes on reserved resources. The request is
forwarded asynchronously to the Mesos agent where the reserved resources are
located. That asynchronous message may not be delivered or creating the volumes
at the agent might fail. This call takes agent_id and volumes details like
the following.
CREATE_VOLUMES HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "CREATE_VOLUMES",
"create_volumes": {
"agent_id": {
"value": "919141a8-b434-4946-86b9-e1b65c8171f6-S0"
},
"volumes": [
{
"type": "SCALAR",
"disk": {
"persistence": {
"id": "id1",
"principal": "my-principal"
},
"volume": {
"container_path": "path1",
"mode": "RW"
}
},
"name": "disk",
"role": "role1",
"scalar": {
"value": 64.0
}
}
]
}
}
CREATE_VOLUMES HTTP Response:
HTTP/1.1 202 Accepted
DESTROY_VOLUMES
This call destroys persistent volumes. The request is forwarded asynchronously to the Mesos agent where the reserved resources are located.
DESTROY_VOLUMES HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "DESTROY_VOLUMES",
"destroy_volumes": {
"agent_id": {
"value": "919141a8-b434-4946-86b9-e1b65c8171f6-S0"
},
"volumes": [
{
"disk": {
"persistence": {
"id": "id1",
"principal": "my-principal"
},
"volume": {
"container_path": "path1",
"mode": "RW"
}
},
"name": "disk",
"role": "role1",
"scalar": {
"value": 64.0
},
"type": "SCALAR"
}
]
}
}
DESTROY_VOLUMES HTTP Response:
HTTP/1.1 202 Accepted
GET_MAINTENANCE_STATUS
This call retrieves the cluster's maintenance status.
GET_MAINTENANCE_STATUS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "GET_MAINTENANCE_STATUS"
}
GET_MAINTENANCE_STATUS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_MAINTENANCE_STATUS",
"get_maintenance_status": {
"status": {
"draining_machines": [
{
"id": {
"ip": "0.0.0.2"
}
},
{
"id": {
"hostname": "myhost"
}
}
]
}
}
}
GET_MAINTENANCE_SCHEDULE
This call retrieves the cluster's maintenance schedule.
GET_MAINTENANCE_SCHEDULE HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "GET_MAINTENANCE_SCHEDULE"
}
GET_MAINTENANCE_SCHEDULE HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_MAINTENANCE_SCHEDULE",
"get_maintenance_schedule": {
"schedule": {
"windows": [
{
"machine_ids": [
{
"hostname": "myhost"
},
{
"ip": "0.0.0.2"
}
],
"unavailability": {
"start": {
"nanoseconds": 1470849373150643200
}
}
}
]
}
}
}
UPDATE_MAINTENANCE_SCHEDULE
This call updates the cluster's maintenance schedule.
UPDATE_MAINTENANCE_SCHEDULE HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "UPDATE_MAINTENANCE_SCHEDULE",
"update_maintenance_schedule": {
"schedule": {
"windows": [
{
"machine_ids": [
{
"hostname": "myhost"
},
{
"ip": "0.0.0.2"
}
],
"unavailability": {
"start": {
"nanoseconds": 1470820233192017920
}
}
}
]
}
}
}
UPDATE_MAINTENANCE_SCHEDULE HTTP Response:
HTTP/1.1 202 Accepted
START_MAINTENANCE
This call starts the maintenance of the cluster, this would bring a set of machines down.
START_MAINTENANCE HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "START_MAINTENANCE",
"start_maintenance": {
"machines": [
{
"hostname": "myhost",
"ip": "0.0.0.3"
}
]
}
}
START_MAINTENANCE HTTP Response:
HTTP/1.1 202 Accepted
STOP_MAINTENANCE
Stops the maintenance of the cluster, this would bring a set of machines back up.
STOP_MAINTENANCE HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "STOP_MAINTENANCE",
"stop_maintenance": {
"machines": [
{
"hostname": "myhost",
"ip": "0.0.0.3"
}
]
}
}
STOP_MAINTENANCE HTTP Response:
HTTP/1.1 202 Accepted
GET_QUOTA
This call retrieves the cluster's configured quotas.
GET_QUOTA HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "GET_QUOTA"
}
GET_QUOTA HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_QUOTA",
"get_quota": {
"status": {
"infos": [
{
"guarantee": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 1.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 512.0
},
"type": "SCALAR"
}
],
"principal": "my-principal",
"role": "role1"
}
]
}
}
}
SET_QUOTA
This call sets the quota for resources to be used by a particular role.
SET_QUOTA HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "SET_QUOTA",
"set_quota": {
"quota_request": {
"force": true,
"guarantee": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 1.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 512.0
},
"type": "SCALAR"
}
],
"role": "role1"
}
}
}
SET_QUOTA HTTP Response:
HTTP/1.1 202 Accepted
REMOVE_QUOTA
This call removes the quota for a particular role.
REMOVE_QUOTA HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: masterhost:5050
Content-Type: application/json
Accept: application/json
{
"type": "REMOVE_QUOTA",
"remove_quota": {
"role": "role1"
}
}
REMOVE_QUOTA HTTP Response:
HTTP/1.1 202 Accepted
Events
Currently, the only call that results in a streaming response is the SUBSCRIBE call sent to the master API.
SUBSCRIBE Request (JSON):
POST /api/v1 HTTP/1.1
Host: agenthost:5051
Content-Type: application/json
Accept: application/json
{
"type": "SUBSCRIBE"
}
SUBSCRIBE Response Event (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked
<event-length>
{
"type": "SUBSCRIBED",
"subscribed" : {
"get_state" : {...}
}
}
<more events>
The client is expected to keep a persistent connection open to the endpoint even after getting a SUBSCRIBED HTTP Response event. This is indicated by "Connection: keep-alive" and "Transfer-Encoding: chunked" headers with no "Content-Length" header set. All subsequent events generated by Mesos are streamed on this connection. The master encodes each Event in RecordIO format, i.e., string representation of length of the event in bytes followed by JSON or binary Protobuf encoded event.
The following events are currently sent by the master. The canonical source of this information is at master.proto. Note that when sending JSON encoded events, master encodes raw bytes in Base64 and strings in UTF-8.
SUBSCRIBED
The first event sent by the master when a client sends a SUBSCRIBE request on the persistent connection. This includes a snapshot of the cluster state. See SUBSCRIBE above for details. Subsequent changes to the cluster state can result in more events (currently only TASK_ADDED and TASK_UPDATED are supported).
TASK_ADDED
Sent whenever a task has been added to the master. This can happen either when a new task launch is processed by the master or when an agent re-registers with a failed over master.
TASK_ADDED Event (JSON)
<event-length>
{
"type": "TASK_ADDED",
"task_added": {
"task": {
"name": "dummy-task",
"task_id": {
"value": "d40f3f3e-bbe3-44af-a230-4cb1eae72f67"
},
"agent_id": {
"value": "f1c9cdc5-195e-41a7-a0d7-adaa9af07f81"
},
"command": {
"value": "sleep",
"arguments": [
"100"
]
}
}
}
}
TASK_UPDATED
Sent whenever the state of the task changes in the master. This can happen when a status update is received or generated by the master. Since status updates are retried by the agent, not all status updates received by the master result in the event being sent.
TASK_UPDATED Event (JSON)
<event-length>
{
"type": "TASK_UPDATED",
"task_updated": {
"task_id": {
"value": "42154f1b-adcd-4421-bf13-8bd11adfafaf"
},
"framework_id": {
"value": "49154f1b-8cf6-4421-bf13-8bd11dccd1f1"
},
"agent_id": {
"value": "2915adf-8aff-4421-bf13-afdafaf1f1"
},
"executor_id": {
"value": "adfaf-adff-2421-bf13-adf23tafa21"
},
"state" : "TASK_RUNNING"
}
}
Agent API
This API contains all the calls accepted by the agent. The canonical source of this information is agent.proto (NOTE: The protobuf definitions are subject to change before the beta API is finalized). These calls are typically made by human operators, tooling or services (e.g., Mesos WebUI). While executors can make these calls as well, it is expected for those to use the Executor HTTP API.
Calls To Agent And Responses
Below are the example calls to agent that result in synchronous responses from the API.
GET_HEALTH
Request and Response are similar to GET_HEALTH call to master.
GET_FLAGS
This call retrieves the agent's flag configuration.
GET_FLAGS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: agenthost:5051
Content-Type: application/json
Accept: application/json
{
“type”: "GET_FLAGS"
}
GET_FLAGS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_FLAGS",
"get_flags": {
"flags": [
{
"name": "acls",
"value": ""
},
{
"name": "appc_simple_discovery_uri_prefix",
"value": "http://"
},
{
"name": "appc_store_dir",
"value": "/tmp/mesos/store/appc"
},
{
"name": "authenticate_http_readonly",
"value": "true"
},
{
"name": "authenticate_http_readwrite",
"value": "true"
},
{
"name": "authenticatee",
"value": "crammd5"
},
{
"name": "authentication_backoff_factor",
"value": "1secs"
},
{
"name": "authorizer",
"value": "local"
},
{
"name": "cgroups_cpu_enable_pids_and_tids_count",
"value": "false"
},
{
"name": "cgroups_enable_cfs",
"value": "false"
},
{
"name": "cgroups_hierarchy",
"value": "/sys/fs/cgroup"
},
{
"name": "cgroups_limit_swap",
"value": "false"
},
{
"name": "cgroups_root",
"value": "mesos"
},
{
"name": "container_disk_watch_interval",
"value": "15secs"
},
{
"name": "containerizers",
"value": "mesos"
},
{
"name": "credential",
"value": "/tmp/directory/credential"
},
{
"name": "default_role",
"value": "*"
},
{
"name": "disk_watch_interval",
"value": "1mins"
},
{
"name": "docker",
"value": "docker"
},
{
"name": "docker_kill_orphans",
"value": "true"
},
{
"name": "docker_registry",
"value": "https://registry-1.docker.io"
},
{
"name": "docker_remove_delay",
"value": "6hrs"
},
{
"name": "docker_socket",
"value": "/var/run/docker.sock"
},
{
"name": "docker_stop_timeout",
"value": "0ns"
},
{
"name": "docker_store_dir",
"value": "/tmp/mesos/store/docker"
},
{
"name": "docker_volume_checkpoint_dir",
"value": "/var/run/mesos/isolators/docker/volume"
},
{
"name": "enforce_container_disk_quota",
"value": "false"
},
{
"name": "executor_registration_timeout",
"value": "1mins"
},
{
"name": "executor_shutdown_grace_period",
"value": "5secs"
},
{
"name": "fetcher_cache_dir",
"value": "/tmp/directory/fetch"
},
{
"name": "fetcher_cache_size",
"value": "2GB"
},
{
"name": "frameworks_home",
"value": ""
},
{
"name": "gc_delay",
"value": "1weeks"
},
{
"name": "gc_disk_headroom",
"value": "0.1"
},
{
"name": "hadoop_home",
"value": ""
},
{
"name": "help",
"value": "false"
},
{
"name": "hostname_lookup",
"value": "true"
},
{
"name": "http_authenticators",
"value": "basic"
},
{
"name": "http_command_executor",
"value": "false"
},
{
"name": "http_credentials",
"value": "/tmp/directory/http_credentials"
},
{
"name": "image_provisioner_backend",
"value": "copy"
},
{
"name": "initialize_driver_logging",
"value": "true"
},
{
"name": "isolation",
"value": "posix/cpu,posix/mem"
},
{
"name": "launcher_dir",
"value": "/my-directory"
},
{
"name": "logbufsecs",
"value": "0"
},
{
"name": "logging_level",
"value": "INFO"
},
{
"name": "oversubscribed_resources_interval",
"value": "15secs"
},
{
"name": "perf_duration",
"value": "10secs"
},
{
"name": "perf_interval",
"value": "1mins"
},
{
"name": "qos_correction_interval_min",
"value": "0ns"
},
{
"name": "quiet",
"value": "false"
},
{
"name": "recover",
"value": "reconnect"
},
{
"name": "recovery_timeout",
"value": "15mins"
},
{
"name": "registration_backoff_factor",
"value": "10ms"
},
{
"name": "resources",
"value": "cpus:2;gpus:0;mem:1024;disk:1024;ports:[31000-32000]"
},
{
"name": "revocable_cpu_low_priority",
"value": "true"
},
{
"name": "sandbox_directory",
"value": "/mnt/mesos/sandbox"
},
{
"name": "strict",
"value": "true"
},
{
"name": "switch_user",
"value": "true"
},
{
"name": "systemd_enable_support",
"value": "true"
},
{
"name": "systemd_runtime_directory",
"value": "/run/systemd/system"
},
{
"name": "version",
"value": "false"
},
{
"name": "work_dir",
"value": "/tmp/directory"
}
]
}
}
GET_VERSION
Request and Response are similar to GET_VERSION call to master.
GET_METRICS
Request and Response are similar to GET_METRICS call to master.
GET_LOGGING_LEVEL
Request and Response are similar to GET_LOGGING_LEVEL call to master.
SET_LOGGING_LEVEL
Request and Response are similar to SET_LOGGING_LEVEL call to master.
LIST_FILES
Request and Response are similar to LIST_FILES call to master.
READ_FILE
Request and Response are similar to READ_FILE call to master.
GET_STATE
This call retrieves full state of the agent i.e. information about the tasks, frameworks and executors running in the cluster.
GET_STATE HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: agenthost:5051
Content-Type: application/json
Accept: application/json
{
“type”: “GET_STATE”
}
GET_STATE HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_STATE",
"get_state": {
"get_executors": {
"executors": [
{
"executor_info": {
"command": {
"arguments": [
"mesos-executor",
"--launcher_dir=/my-directory"
],
"shell": false,
"value": "my-directory"
},
"executor_id": {
"value": "1"
},
"framework_id": {
"value": "8903b84e-112f-4b5f-aad3-7366f6ae7ecc-0000"
},
"name": "Command Executor (Task: 1) (Command: sh -c 'sleep 1000')",
"resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 0.1
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 32.0
},
"type": "SCALAR"
}
],
"source": "1"
}
}
]
},
"get_frameworks": {
"frameworks": [
{
"framework_info": {
"checkpoint": false,
"failover_timeout": 0.0,
"hostname": "myhost",
"id": {
"value": "8903b84e-112f-4b5f-aad3-7366f6ae7ecc-0000"
},
"name": "default",
"principal": "my-principal",
"role": "*",
"user": "root"
}
}
]
},
"get_tasks": {
"launched_tasks": [
{
"agent_id": {
"value": "8903b84e-112f-4b5f-aad3-7366f6ae7ecc-S0"
},
"framework_id": {
"value": "8903b84e-112f-4b5f-aad3-7366f6ae7ecc-0000"
},
"name": "",
"resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 2.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "disk",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "ports",
"ranges": {
"range": [
{
"begin": 31000,
"end": 32000
}
]
},
"role": "*",
"type": "RANGES"
}
],
"state": "TASK_RUNNING",
"status_update_state": "TASK_RUNNING",
"status_update_uuid": "2qlPayEJRJGPeaWlahI+WA==",
"statuses": [
{
"agent_id": {
"value": "8903b84e-112f-4b5f-aad3-7366f6ae7ecc-S0"
},
"container_status": {
"executor_pid": 19846,
"network_infos": [
{
"ip_addresses": [
{
"ip_address": "127.0.1.1"
}
]
}
]
},
"executor_id": {
"value": "1"
},
"source": "SOURCE_EXECUTOR",
"state": "TASK_RUNNING",
"task_id": {
"value": "1"
},
"timestamp": 1470898839.48066,
"uuid": "2qlPayEJRJGPeaWlahI+WA=="
}
],
"task_id": {
"value": "1"
}
}
]
}
}
}
GET_CONTAINERS
This call retrieves information about containers running on this agent. It contains ContainerStatus and ResourceStatistics along with some metadata of the containers.
GET_CONTAINERS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: agenthost:5051
Content-Type: application/json
Accept: application/json
{
“type”: “GET_CONTAINERS”
}
GET_CONTAINERS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_CONTAINERS",
"get_containers": {
"containers": [
{
"container_id": {
"value": "f0f97041-1860-4b4a-b279-91fec4e0ebd8"
},
"container_status": {
"network_infos": [
{
"ip_addresses": [
{
"ip_address": "192.168.1.20"
}
]
}
]
},
"executor_id": {
"value": "default"
},
"executor_name": "",
"framework_id": {
"value": "cbe3c0f1-5655-4110-bc01-ae658a9dbab9-0000"
},
"resource_statistics": {
"mem_limit_bytes": 2048,
"timestamp": 0.0
}
}
]
}
}
GET_FRAMEWORKS
This call retrieves information about all the frameworks known to the agent at the current time.
GET_FRAMEWORKS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: agenthost:5051
Content-Type: application/json
Accept: application/json
{
“type”: "GET_FRAMEWORKS"
}
GET_FRAMEWORKS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_FRAMEWORKS",
"get_frameworks": {
"frameworks": [
{
"framework_info": {
"checkpoint": false,
"failover_timeout": 0.0,
"hostname": "myhost",
"id": {
"value": "17e8c0d4-5ee2-4937-bc1c-06c39eddb004-0000"
},
"name": "default",
"principal": "my-principal",
"role": "*",
"user": "root"
}
}
]
}
}
GET_EXECUTORS
This call retrieves information about all the executors known to the agent at the current time.
GET_EXECUTORS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: agenthost:5051
Content-Type: application/json
Accept: application/json
{
“type”: "GET_EXECUTORS"
}
GET_EXECUTORS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "GET_EXECUTORS",
"get_executors": {
"executors": [
{
"executor_info": {
"command": {
"arguments": [
"mesos-executor",
"--launcher_dir=/my-directory"
],
"shell": false,
"value": "/my-directory"
},
"executor_id": {
"value": "1"
},
"framework_id": {
"value": "5ffcfa79-00c4-4d93-94a3-2f3844126fd9-0000"
},
"name": "Command Executor (Task: 1) (Command: sh -c 'sleep 1000')",
"resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 0.1
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 32.0
},
"type": "SCALAR"
}
],
"source": "1"
}
}
]
}
}
GET_TASKS
This call retrieves information about all the tasks known to the agent.
GET_TASKS HTTP Request (JSON):
POST /api/v1 HTTP/1.1
Host: agenthost:5051
Content-Type: application/json
Accept: application/json
{
}
GET_TASKS HTTP Response (JSON):
HTTP/1.1 200 OK
Content-Type: application/json
{
“type”: “GET_TASKS”,
"get_tasks": {
"launched_tasks": [
{
"agent_id": {
"value": "70770d61-d666-4547-a808-787f63b00cf2-S0"
},
"framework_id": {
"value": "70770d61-d666-4547-a808-787f63b00cf2-0000"
},
"name": "",
"resources": [
{
"name": "cpus",
"role": "*",
"scalar": {
"value": 2.0
},
"type": "SCALAR"
},
{
"name": "mem",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "disk",
"role": "*",
"scalar": {
"value": 1024.0
},
"type": "SCALAR"
},
{
"name": "ports",
"ranges": {
"range": [
{
"begin": 31000,
"end": 32000
}
]
},
"role": "*",
"type": "RANGES"
}
],
"state": "TASK_RUNNING",
"status_update_state": "TASK_RUNNING",
"status_update_uuid": "0RC72iyRTQefoUL0ClcL0g==",
"statuses": [
{
"agent_id": {
"value": "70770d61-d666-4547-a808-787f63b00cf2-S0"
},
"container_status": {
"executor_pid": 27140,
"network_infos": [
{
"ip_addresses": [
{
"ip_address": "127.0.1.1"
}
]
}
]
},
"executor_id": {
"value": "1"
},
"source": "SOURCE_EXECUTOR",
"state": "TASK_RUNNING",
"task_id": {
"value": "1"
},
"timestamp": 1470900791.21577,
"uuid": "0RC72iyRTQefoUL0ClcL0g=="
}
],
"task_id": {
"value": "1"
}
}
]
}
}