publish/documentation/latest/endpoints/master/state/index.html - mesos-site - Git at Google

 <!DOCTYPE html>
 <html>
   <head>
     <meta charset="utf-8">
     <title>Apache Mesos - HTTP Endpoints - /state</title>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">

     <meta property="og:locale" content="en_US"/>
     <meta property="og:type" content="website"/>
     <meta property="og:title" content="Apache Mesos"/>
     <meta property="og:site_name" content="Apache Mesos"/>
     <meta property="og:url" content="http://mesos.apache.org/"/>
     <meta property="og:image" content="http://mesos.apache.org/assets/img/mesos_logo_fb_preview.png"/>
     <meta property="og:description"
           content="Apache Mesos abstracts resources away from machines,
                    enabling fault-tolerant and elastic distributed systems
                    to easily be built and run effectively."/>

     <meta name="twitter:card" content="summary"/>
     <meta name="twitter:site" content="@ApacheMesos"/>
     <meta name="twitter:title" content="Apache Mesos"/>
     <meta name="twitter:image" content="http://mesos.apache.org/assets/img/mesos_logo_fb_preview.png"/>
     <meta name="twitter:description"
           content="Apache Mesos abstracts resources away from machines,
                    enabling fault-tolerant and elastic distributed systems
                    to easily be built and run effectively."/>

     <link href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet">
     <link rel="alternate" type="application/atom+xml" title="Apache Mesos Blog" href="/blog/feed.xml">
     <link href="../../../../../assets/css/main.css" media="screen" rel="stylesheet" type="text/css" />


     <!-- Google Analytics Magic -->
     <script type="text/javascript">
     var _gaq = _gaq || [];
     _gaq.push(['_setAccount', 'UA-20226872-1']);
     _gaq.push(['_setDomainName', 'apache.org']);
     _gaq.push(['_trackPageview']);

     (function() {
       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
     })();
     </script>

   </head>
   <body>
     <!-- magical breadcrumbs -->
     <div class="topnav">
       <div class="container">
         <ul class="breadcrumb">
           <li>
             <div class="dropdown">
               <a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a>
               <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel">
                 <li><a href="http://www.apache.org">Apache Homepage</a></li>
                 <li><a href="http://www.apache.org/licenses/">License</a></li>
                 <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
                 <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
                 <li><a href="http://www.apache.org/security/">Security</a></li>
               </ul>
             </div>
           </li>

           <li><a href="http://mesos.apache.org">Apache Mesos</a></li>


           <li><a href="/documentation
 /">Documentation
 </a></li>


         </ul><!-- /.breadcrumb -->
       </div><!-- /.container -->
     </div><!-- /.topnav -->

     <!-- navbar excitement -->
 <div class="navbar navbar-default navbar-static-top" role="navigation">
   <div class="container">
     <div class="navbar-header">
       <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#mesos-menu" aria-expanded="false">
       <span class="sr-only">Toggle navigation</span>
       <span class="icon-bar"></span>
       <span class="icon-bar"></span>
       <span class="icon-bar"></span>
       </button>
       <a class="navbar-brand" href="/"><img src="/assets/img/mesos_logo.png" alt="Apache Mesos logo"/></a>
     </div><!-- /.navbar-header -->

     <div class="navbar-collapse collapse" id="mesos-menu">
       <ul class="nav navbar-nav navbar-right">
         <li><a href="/gettingstarted/">Getting Started</a></li>
         <li><a href="/blog/">Blog</a></li>
         <li><a href="/documentation/latest/">Documentation</a></li>
         <li><a href="/downloads/">Downloads</a></li>
         <li><a href="/community/">Community</a></li>
       </ul>
     </div><!-- /#mesos-menu -->
   </div><!-- /.container -->
 </div><!-- /.navbar -->

 <div class="content">
   <div class="container">
     <div class="row-fluid">
   <div class="col-md-4">
     <h4>If you're new to Mesos</h4>
     <p>See the <a href="/gettingstarted/">getting started</a> page for more
        information about downloading, building, and deploying Mesos.</p>

     <h4>If you'd like to get involved or you're looking for support</h4>
     <p>See our <a href="/community/">community</a> page for more details.</p>
   </div>
   <div class="col-md-8">
     <!--- This is an automatically generated file. DO NOT EDIT! --->


 <h3>USAGE</h3>

 <blockquote><pre><code>   /state
    /master/state
 </code></pre></blockquote>

 <h3>TL;DR;</h3>

 <p>Information about state of master.</p>

 <h3>DESCRIPTION</h3>

 <p>Returns 200 OK when the state of the master was queried successfully.
 Returns 307 TEMPORARY_REDIRECT redirect to the leading master when
 current master is not the leader.
 Returns 503 SERVICE_UNAVAILABLE if the leading master cannot be
 found.
 This endpoint shows information about the frameworks, tasks,
 executors and agents running in the cluster as a JSON object.
 The information shown might be filtered based on the user
 accessing the endpoint.</p>

 <p>Example (<strong>Note</strong>: this is not exhaustive):</p>

 <pre><code>{
     "version" : "0.28.0",
     "git_sha" : "9d5889b5a265849886a533965f4aefefd1fbd103",
     "git_branch" : "refs/heads/master",
     "git_tag" : "0.28.0",
     "build_date" : "2016-02-15 10:00:28",
     "build_time" : 1455559228,
     "build_user" : "mesos-user",
     "start_time" : 1455643643.42422,
     "elected_time" : 1455643643.43457,
     "id" : "b5eac2c5-609b-4ca1-a352-61941702fc9e",
     "pid" : "master@127.0.0.1:5050",
     "hostname" : "localhost",
     "activated_slaves" : 0,
     "deactivated_slaves" : 0,
     "cluster" : "test-cluster",
     "leader" : "master@127.0.0.1:5050",
     "log_dir" : "/var/log",
     "external_log_file" : "mesos.log",
     "flags" : {
          "framework_sorter" : "drf",
          "authenticate" : "false",
          "logbufsecs" : "0",
          "initialize_driver_logging" : "true",
          "work_dir" : "/var/lib/mesos",
          "http_authenticators" : "basic",
          "authorizers" : "local",
          "agent_reregister_timeout" : "10mins",
          "logging_level" : "INFO",
          "help" : "false",
          "root_submissions" : "true",
          "ip" : "127.0.0.1",
          "user_sorter" : "drf",
          "version" : "false",
          "max_agent_ping_timeouts" : "5",
          "agent_ping_timeout" : "15secs",
          "registry_store_timeout" : "20secs",
          "max_completed_frameworks" : "50",
          "quiet" : "false",
          "allocator" : "HierarchicalDRF",
          "hostname_lookup" : "true",
          "authenticators" : "crammd5",
          "max_completed_tasks_per_framework" : "1000",
          "registry" : "replicated_log",
          "registry_strict" : "false",
          "log_auto_initialize" : "true",
          "authenticate_agents" : "false",
          "registry_fetch_timeout" : "1mins",
          "allocation_interval" : "1secs",
          "authenticate_http" : "false",
          "port" : "5050",
          "zk_session_timeout" : "10secs",
          "recovery_agent_removal_limit" : "100%",
          "webui_dir" : "/path/to/mesos/build/../src/webui",
          "cluster" : "mycluster",
          "leader" : "master@127.0.0.1:5050",
          "log_dir" : "/var/log",
          "external_log_file" : "mesos.log"
     },
     "slaves" : [],
     "frameworks" : [],
     "completed_frameworks" : [],
     "orphan_tasks" : [],
     "unregistered_frameworks" : []
 }
 </code></pre>

 <h3>AUTHENTICATION</h3>

 <p>This endpoint requires authentication iff HTTP authentication is
 enabled.</p>

 <h3>AUTHORIZATION</h3>

 <p>This endpoint might be filtered based on the user accessing it.
 For example a user might only see the subset of frameworks,
 tasks, and executors they are allowed to view.
 See the authorization documentation for details.</p>

   </div>
 </div>

   </div><!-- /.container -->
 </div><!-- /.content -->

 <hr>


     <!-- footer -->
     <div class="footer">
       <div class="container">
         <div class="col-md-4 social-blk">
           <span class="social">
             <a href="https://twitter.com/ApacheMesos"
               class="twitter-follow-button"
               data-show-count="false" data-size="large">Follow @ApacheMesos</a>
             <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
             <a href="https://twitter.com/intent/tweet?button_hashtag=mesos"
               class="twitter-hashtag-button"
               data-size="large"
               data-related="ApacheMesos">Tweet #mesos</a>
             <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
           </span>
         </div>

         <div class="col-md-8 trademark">
           <p>&copy; 2012-2017 <a href="http://apache.org">The Apache Software Foundation</a>.
             Apache Mesos, the Apache feather logo, and the Apache Mesos project logo are trademarks of The Apache Software Foundation.
           <p>
         </div>
       </div><!-- /.container -->
     </div><!-- /.footer -->

     <!-- JS -->
     <script src="//code.jquery.com/jquery-1.11.0.min.js" type="text/javascript"></script>
     <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js" type="text/javascript"></script>
   </body>
 </html>
	<!DOCTYPE html>
	<html>
	<head>
	<meta charset="utf-8">
	<title>Apache Mesos - HTTP Endpoints - /state</title>
	<meta name="viewport" content="width=device-width, initial-scale=1.0">

	<meta property="og:locale" content="en_US"/>
	<meta property="og:type" content="website"/>
	<meta property="og:title" content="Apache Mesos"/>
	<meta property="og:site_name" content="Apache Mesos"/>
	<meta property="og:url" content="http://mesos.apache.org/"/>
	<meta property="og:image" content="http://mesos.apache.org/assets/img/mesos_logo_fb_preview.png"/>
	<meta property="og:description"
	content="Apache Mesos abstracts resources away from machines,
	enabling fault-tolerant and elastic distributed systems
	to easily be built and run effectively."/>

	<meta name="twitter:card" content="summary"/>
	<meta name="twitter:site" content="@ApacheMesos"/>
	<meta name="twitter:title" content="Apache Mesos"/>
	<meta name="twitter:image" content="http://mesos.apache.org/assets/img/mesos_logo_fb_preview.png"/>
	<meta name="twitter:description"
	content="Apache Mesos abstracts resources away from machines,
	enabling fault-tolerant and elastic distributed systems
	to easily be built and run effectively."/>

	<link href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet">
	<link rel="alternate" type="application/atom+xml" title="Apache Mesos Blog" href="/blog/feed.xml">
	<link href="../../../../../assets/css/main.css" media="screen" rel="stylesheet" type="text/css" />



	<!-- Google Analytics Magic -->
	<script type="text/javascript">
	var _gaq = _gaq \|\| [];
	_gaq.push(['_setAccount', 'UA-20226872-1']);
	_gaq.push(['_setDomainName', 'apache.org']);
	_gaq.push(['_trackPageview']);

	(function() {
	var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
	ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
	var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
	})();
	</script>

	</head>
	<body>
	<!-- magical breadcrumbs -->
	<div class="topnav">
	<div class="container">
	<ul class="breadcrumb">
	<li>
	<div class="dropdown">
	<a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a>
	<ul class="dropdown-menu" role="menu" aria-labelledby="dLabel">
	<li><a href="http://www.apache.org">Apache Homepage</a></li>
	<li><a href="http://www.apache.org/licenses/">License</a></li>
	<li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
	<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
	<li><a href="http://www.apache.org/security/">Security</a></li>
	</ul>
	</div>
	</li>

	<li><a href="http://mesos.apache.org">Apache Mesos</a></li>


	<li><a href="/documentation
	/">Documentation
	</a></li>


	</ul><!-- /.breadcrumb -->
	</div><!-- /.container -->
	</div><!-- /.topnav -->

	<!-- navbar excitement -->
	<div class="navbar navbar-default navbar-static-top" role="navigation">
	<div class="container">
	<div class="navbar-header">
	<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#mesos-menu" aria-expanded="false">
	<span class="sr-only">Toggle navigation</span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</button>
	<a class="navbar-brand" href="/"><img src="/assets/img/mesos_logo.png" alt="Apache Mesos logo"/></a>
	</div><!-- /.navbar-header -->

	<div class="navbar-collapse collapse" id="mesos-menu">
	<ul class="nav navbar-nav navbar-right">
	<li><a href="/gettingstarted/">Getting Started</a></li>
	<li><a href="/blog/">Blog</a></li>
	<li><a href="/documentation/latest/">Documentation</a></li>
	<li><a href="/downloads/">Downloads</a></li>
	<li><a href="/community/">Community</a></li>
	</ul>
	</div><!-- /#mesos-menu -->
	</div><!-- /.container -->
	</div><!-- /.navbar -->

	<div class="content">
	<div class="container">
	<div class="row-fluid">
	<div class="col-md-4">
	<h4>If you're new to Mesos</h4>
	<p>See the <a href="/gettingstarted/">getting started</a> page for more
	information about downloading, building, and deploying Mesos.</p>

	<h4>If you'd like to get involved or you're looking for support</h4>
	<p>See our <a href="/community/">community</a> page for more details.</p>
	</div>
	<div class="col-md-8">
	<!--- This is an automatically generated file. DO NOT EDIT! --->


	<h3>USAGE</h3>

	<blockquote><pre><code> /state
	/master/state
	</code></pre></blockquote>

	<h3>TL;DR;</h3>

	<p>Information about state of master.</p>

	<h3>DESCRIPTION</h3>

	<p>Returns 200 OK when the state of the master was queried successfully.
	Returns 307 TEMPORARY_REDIRECT redirect to the leading master when
	current master is not the leader.
	Returns 503 SERVICE_UNAVAILABLE if the leading master cannot be
	found.
	This endpoint shows information about the frameworks, tasks,
	executors and agents running in the cluster as a JSON object.
	The information shown might be filtered based on the user
	accessing the endpoint.</p>

	<p>Example (<strong>Note</strong>: this is not exhaustive):</p>

	<pre><code>{
	"version" : "0.28.0",
	"git_sha" : "9d5889b5a265849886a533965f4aefefd1fbd103",
	"git_branch" : "refs/heads/master",
	"git_tag" : "0.28.0",
	"build_date" : "2016-02-15 10:00:28",
	"build_time" : 1455559228,
	"build_user" : "mesos-user",
	"start_time" : 1455643643.42422,
	"elected_time" : 1455643643.43457,
	"id" : "b5eac2c5-609b-4ca1-a352-61941702fc9e",
	"pid" : "master@127.0.0.1:5050",
	"hostname" : "localhost",
	"activated_slaves" : 0,
	"deactivated_slaves" : 0,
	"cluster" : "test-cluster",
	"leader" : "master@127.0.0.1:5050",
	"log_dir" : "/var/log",
	"external_log_file" : "mesos.log",
	"flags" : {
	"framework_sorter" : "drf",
	"authenticate" : "false",
	"logbufsecs" : "0",
	"initialize_driver_logging" : "true",
	"work_dir" : "/var/lib/mesos",
	"http_authenticators" : "basic",
	"authorizers" : "local",
	"agent_reregister_timeout" : "10mins",
	"logging_level" : "INFO",
	"help" : "false",
	"root_submissions" : "true",
	"ip" : "127.0.0.1",
	"user_sorter" : "drf",
	"version" : "false",
	"max_agent_ping_timeouts" : "5",
	"agent_ping_timeout" : "15secs",
	"registry_store_timeout" : "20secs",
	"max_completed_frameworks" : "50",
	"quiet" : "false",
	"allocator" : "HierarchicalDRF",
	"hostname_lookup" : "true",
	"authenticators" : "crammd5",
	"max_completed_tasks_per_framework" : "1000",
	"registry" : "replicated_log",
	"registry_strict" : "false",
	"log_auto_initialize" : "true",
	"authenticate_agents" : "false",
	"registry_fetch_timeout" : "1mins",
	"allocation_interval" : "1secs",
	"authenticate_http" : "false",
	"port" : "5050",
	"zk_session_timeout" : "10secs",
	"recovery_agent_removal_limit" : "100%",
	"webui_dir" : "/path/to/mesos/build/../src/webui",
	"cluster" : "mycluster",
	"leader" : "master@127.0.0.1:5050",
	"log_dir" : "/var/log",
	"external_log_file" : "mesos.log"
	},
	"slaves" : [],
	"frameworks" : [],
	"completed_frameworks" : [],
	"orphan_tasks" : [],
	"unregistered_frameworks" : []
	}
	</code></pre>

	<h3>AUTHENTICATION</h3>

	<p>This endpoint requires authentication iff HTTP authentication is
	enabled.</p>

	<h3>AUTHORIZATION</h3>

	<p>This endpoint might be filtered based on the user accessing it.
	For example a user might only see the subset of frameworks,
	tasks, and executors they are allowed to view.
	See the authorization documentation for details.</p>

	</div>
	</div>

	</div><!-- /.container -->
	</div><!-- /.content -->

	<hr>



	<!-- footer -->
	<div class="footer">
	<div class="container">
	<div class="col-md-4 social-blk">
	<span class="social">
	<a href="https://twitter.com/ApacheMesos"
	class="twitter-follow-button"
	data-show-count="false" data-size="large">Follow @ApacheMesos</a>
	<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
	<a href="https://twitter.com/intent/tweet?button_hashtag=mesos"
	class="twitter-hashtag-button"
	data-size="large"
	data-related="ApacheMesos">Tweet #mesos</a>
	<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
	</span>
	</div>

	<div class="col-md-8 trademark">
	<p>© 2012-2017 <a href="http://apache.org">The Apache Software Foundation</a>.
	Apache Mesos, the Apache feather logo, and the Apache Mesos project logo are trademarks of The Apache Software Foundation.
	<p>
	</div>
	</div><!-- /.container -->
	</div><!-- /.footer -->

	<!-- JS -->
	<script src="//code.jquery.com/jquery-1.11.0.min.js" type="text/javascript"></script>
	<script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js" type="text/javascript"></script>
	</body>
	</html>