ResourceManagerRest.html
No OneTemporary
Actions

Subscribers

None

File Metadata

Created: Tue, Feb 25, 19:22

ResourceManagerRest.html
View Options

	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<!-- Generated by Apache Maven Doxia at 2014-02-11 -->
	<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
	<title>Apache Hadoop 2.3.0 - ResourceManager REST API's.</title>
	<style type="text/css" media="all">
	@import url("./css/maven-base.css");
	@import url("./css/maven-theme.css");
	@import url("./css/site.css");
	</style>
	<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
	<meta name="Date-Revision-yyyymmdd" content="20140211" />
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	</head>
	<body class="composite">
	<div id="banner">
	<a href="http://hadoop.apache.org/" id="bannerLeft">
	<img src="http://hadoop.apache.org/images/hadoop-logo.jpg" alt="" />
	</a>
	<a href="http://www.apache.org/" id="bannerRight">
	<img src="http://www.apache.org/images/asf_logo_wide.png" alt="" />
	</a>
	<div class="clear">
	<hr/>
	</div>
	</div>
	<div id="breadcrumbs">

	<div class="xleft">
	<a href="http://www.apache.org/" class="externalLink">Apache</a>
	>
	<a href="http://hadoop.apache.org/" class="externalLink">Hadoop</a>
	>
	<a href="../">hadoop-yarn</a>
	>
	Apache Hadoop 2.3.0
	</div>
	<div class="xright"> <a href="http://wiki.apache.org/hadoop" class="externalLink">Wiki</a>
	\|
	<a href="https://svn.apache.org/repos/asf/hadoop/" class="externalLink">SVN</a>
	\|
	<a href="http://hadoop.apache.org/" class="externalLink">Apache Hadoop</a>

	\| Last Published: 2014-02-11
	\| Version: 2.3.0
	</div>
	<div class="clear">
	<hr/>
	</div>
	</div>
	<div id="leftColumn">
	<div id="navcolumn">

	<h5>General</h5>
	<ul>
	<li class="none">
	<a href="../../index.html">Overview</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/SingleCluster.html">Single Node Setup</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/ClusterSetup.html">Cluster Setup</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/CommandsManual.html">Hadoop Commands Reference</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/FileSystemShell.html">File System Shell</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/Compatibility.html">Hadoop Compatibility</a>
	</li>
	</ul>
	<h5>Common</h5>
	<ul>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/CLIMiniCluster.html">CLI Mini Cluster</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/NativeLibraries.html">Native Libraries</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/Superusers.html">Superusers</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/SecureMode.html">Secure Mode</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/ServiceLevelAuth.html">Service Level Authorization</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/HttpAuthentication.html">HTTP Authentication</a>
	</li>
	</ul>
	<h5>HDFS</h5>
	<ul>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html">HDFS User Guide</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/HDFSHighAvailabilityWithQJM.html">High Availability With QJM</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/HDFSHighAvailabilityWithNFS.html">High Availability With NFS</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/Federation.html">Federation</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/HdfsSnapshots.html">HDFS Snapshots</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/HdfsDesign.html">HDFS Architecture</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/HdfsEditsViewer.html">Edits Viewer</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/HdfsImageViewer.html">Image Viewer</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/HdfsPermissionsGuide.html">Permissions and HDFS</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/HdfsQuotaAdminGuide.html">Quotas and HDFS</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/Hftp.html">HFTP</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/LibHdfs.html">C API libhdfs</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/WebHDFS.html">WebHDFS REST API</a>
	</li>
	<li class="none">
	<a href="../../hadoop-hdfs-httpfs/index.html">HttpFS Gateway</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/ShortCircuitLocalReads.html">Short Circuit Local Reads</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/CentralizedCacheManagement.html">Centralized Cache Management</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/HdfsNfsGateway.html">HDFS NFS Gateway</a>
	</li>
	</ul>
	<h5>MapReduce</h5>
	<ul>
	<li class="none">
	<a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduce_Compatibility_Hadoop1_Hadoop2.html">Compatibilty between Hadoop 1.x and Hadoop 2.x</a>
	</li>
	<li class="none">
	<a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/EncryptedShuffle.html">Encrypted Shuffle</a>
	</li>
	<li class="none">
	<a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/PluggableShuffleAndPluggableSort.html">Pluggable Shuffle/Sort</a>
	</li>
	<li class="none">
	<a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/DistributedCacheDeploy.html">Distributed Cache Deploy</a>
	</li>
	</ul>
	<h5>YARN</h5>
	<ul>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/YARN.html">YARN Architecture</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/WritingYarnApplications.html">Writing YARN Applications</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/CapacityScheduler.html">Capacity Scheduler</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/FairScheduler.html">Fair Scheduler</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/WebApplicationProxy.html">Web Application Proxy</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/YarnCommands.html">YARN Commands</a>
	</li>
	<li class="none">
	<a href="../../hadoop-sls/SchedulerLoadSimulator.html">Scheduler Load Simulator</a>
	</li>
	</ul>
	<h5>YARN REST APIs</h5>
	<ul>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/WebServicesIntro.html">Introduction</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/ResourceManagerRest.html">Resource Manager</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/NodeManagerRest.html">Node Manager</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/MapredAppMasterRest.html">MR Application Master</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-site/HistoryServerRest.html">History Server</a>
	</li>
	</ul>
	<h5>Auth</h5>
	<ul>
	<li class="none">
	<a href="../../hadoop-auth/index.html">Overview</a>
	</li>
	<li class="none">
	<a href="../../hadoop-auth/Examples.html">Examples</a>
	</li>
	<li class="none">
	<a href="../../hadoop-auth/Configuration.html">Configuration</a>
	</li>
	<li class="none">
	<a href="../../hadoop-auth/BuildingIt.html">Building</a>
	</li>
	</ul>
	<h5>Reference</h5>
	<ul>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/releasenotes.html">Release Notes</a>
	</li>
	<li class="none">
	<a href="../../api/index.html">API docs</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/CHANGES.txt">Common CHANGES.txt</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/CHANGES.txt">HDFS CHANGES.txt</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-mapreduce/CHANGES.txt">MapReduce CHANGES.txt</a>
	</li>
	</ul>
	<h5>Configuration</h5>
	<ul>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/core-default.xml">core-default.xml</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-hdfs/hdfs-default.xml">hdfs-default.xml</a>
	</li>
	<li class="none">
	<a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/mapred-default.xml">mapred-default.xml</a>
	</li>
	<li class="none">
	<a href="../../hadoop-yarn/hadoop-yarn-common/yarn-default.xml">yarn-default.xml</a>
	</li>
	<li class="none">
	<a href="../../hadoop-project-dist/hadoop-common/DeprecatedProperties.html">Deprecated Properties</a>
	</li>
	</ul>
	<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
	<img alt="Built by Maven" src="./images/logos/maven-feather.png"/>
	</a>

	</div>
	</div>
	<div id="bodyColumn">
	<div id="contentBox">
	<!-- Licensed under the Apache License, Version 2.0 (the "License"); --><!-- you may not use this file except in compliance with the License. --><!-- You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, software --><!-- distributed under the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --><!-- See the License for the specific language governing permissions and --><!-- limitations under the License. See accompanying LICENSE file. --><div class="section">
	<h2>ResourceManager REST API's.<a name="ResourceManager_REST_APIs."></a></h2>
	<p>[ <a href="./index.html">Go Back</a> ]</p>
	<ul>
	<li><a href="#ResourceManager_REST_APIs.">ResourceManager REST API's.</a>
	<ul>
	<li><a href="#Overview">Overview</a></li>
	<li><a href="#Cluster_Information_API">Cluster Information API</a></li>
	<li><a href="#Cluster_Metrics_API">Cluster Metrics API</a></li>
	<li><a href="#Cluster_Scheduler_API">Cluster Scheduler API</a></li>
	<li><a href="#Cluster_Applications_API">Cluster Applications API</a></li>
	<li><a href="#Cluster_Application_Statistics_API">Cluster Application Statistics API</a></li>
	<li><a href="#Cluster_Application_API">Cluster Application API</a></li>
	<li><a href="#Cluster_Application_Attempts_API">Cluster Application Attempts API</a></li>
	<li><a href="#Cluster_Nodes_API">Cluster Nodes API</a></li>
	<li><a href="#Cluster_Node_API">Cluster Node API</a></li></ul></li></ul>
	<div class="section">
	<h3>Overview<a name="Overview"></a></h3>
	<p>The ResourceManager REST API's allow the user to get information about the cluster - status on the cluster, metrics on the cluster, scheduler information, information about nodes in the cluster, and information about applications on the cluster.</p></div>
	<div class="section">
	<h3>Cluster Information API<a name="Cluster_Information_API"></a></h3>
	<p>The cluster information resource provides overall information about the cluster. </p>
	<div class="section">
	<h4>URI<a name="URI"></a></h4>
	<p>Both of the following URI's give you the cluster information.</p>
	<div>
	<pre> * http://<rm http address:port>/ws/v1/cluster
	* http://<rm http address:port>/ws/v1/cluster/info</pre></div></div>
	<div class="section">
	<h4>HTTP Operations Supported<a name="HTTP_Operations_Supported"></a></h4>
	<div>
	<pre> * GET</pre></div></div>
	<div class="section">
	<h4>Query Parameters Supported<a name="Query_Parameters_Supported"></a></h4>
	<div>
	<pre> None</pre></div></div>
	<div class="section">
	<h4>Elements of the <i>clusterInfo</i> object<a name="Elements_of_the_clusterInfo_object"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">id</td>
	<td align="left">long</td>
	<td align="left">The cluster id</td></tr>
	<tr class="a">
	<td align="left">startedOn</td>
	<td align="left">long</td>
	<td align="left">The time the cluster started (in ms since epoch)</td></tr>
	<tr class="b">
	<td align="left">state</td>
	<td align="left">string</td>
	<td align="left">The ResourceManager state - valid values are: NOTINITED, INITED, STARTED, STOPPED</td></tr>
	<tr class="a">
	<td align="left">haState</td>
	<td align="left">string</td>
	<td align="left">The ResourceManager HA state - valid values are: INITIALIZING, ACTIVE, STANDBY, STOPPED</td></tr>
	<tr class="b">
	<td align="left">resourceManagerVersion</td>
	<td align="left">string</td>
	<td align="left">Version of the ResourceManager</td></tr>
	<tr class="a">
	<td align="left">resourceManagerBuildVersion</td>
	<td align="left">string</td>
	<td align="left">ResourceManager build string with build version, user, and checksum</td></tr>
	<tr class="b">
	<td align="left">resourceManagerVersionBuiltOn</td>
	<td align="left">string</td>
	<td align="left">Timestamp when ResourceManager was built (in ms since epoch)</td></tr>
	<tr class="a">
	<td align="left">hadoopVersion</td>
	<td align="left">string</td>
	<td align="left">Version of hadoop common</td></tr>
	<tr class="b">
	<td align="left">hadoopBuildVersion</td>
	<td align="left">string</td>
	<td align="left">Hadoop common build string with build version, user, and checksum</td></tr>
	<tr class="a">
	<td align="left">hadoopVersionBuiltOn</td>
	<td align="left">string</td>
	<td align="left">Timestamp when hadoop common was built(in ms since epoch)</td></tr></table></div>
	<div class="section">
	<h4>Response Examples<a name="Response_Examples"></a></h4>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/info</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre>{
	"clusterInfo":
	{
	"id":1324053971963,
	"startedOn":1324053971963,
	"state":"STARTED",
	"resourceManagerVersion":"0.23.1-SNAPSHOT",
	"resourceManagerBuildVersion":"0.23.1-SNAPSHOT from 1214049 by user1 source checksum 050cd664439d931c8743a6428fd6a693",
	"resourceManagerVersionBuiltOn":"Tue Dec 13 22:12:48 CST 2011",
	"hadoopVersion":"0.23.1-SNAPSHOT",
	"hadoopBuildVersion":"0.23.1-SNAPSHOT from 1214049 by user1 source checksum 11458df3bb77342dca5f917198fad328",
	"hadoopVersionBuiltOn":"Tue Dec 13 22:12:26 CST 2011"
	}
	}</pre></div>
	<p><b>XML response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> Accept: application/xml
	GET http://<rm http address:port>/ws/v1/cluster/info</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 712
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<clusterInfo>
	<id>1324053971963</id>
	<startedOn>1324053971963</startedOn>
	<state>STARTED</state>
	<resourceManagerVersion>0.23.1-SNAPSHOT</resourceManagerVersion>
	<resourceManagerBuildVersion>0.23.1-SNAPSHOT from 1214049 by user1 source checksum 050cd664439d931c8743a6428fd6a693</resourceManagerBuildVersion>
	<resourceManagerVersionBuiltOn>Tue Dec 13 22:12:48 CST 2011</resourceManagerVersionBuiltOn>
	<hadoopVersion>0.23.1-SNAPSHOT</hadoopVersion>
	<hadoopBuildVersion>0.23.1-SNAPSHOT from 1214049 by user1 source checksum 11458df3bb77342dca5f917198fad328</hadoopBuildVersion>
	<hadoopVersionBuiltOn>Tue Dec 13 22:12:48 CST 2011</hadoopVersionBuiltOn>
	</clusterInfo></pre></div></div></div>
	<div class="section">
	<h3>Cluster Metrics API<a name="Cluster_Metrics_API"></a></h3>
	<p>The cluster metrics resource provides some overall metrics about the cluster. More detailed metrics should be retrieved from the jmx interface.</p>
	<div class="section">
	<h4>URI<a name="URI"></a></h4>
	<div>
	<pre> * http://<rm http address:port>/ws/v1/cluster/metrics</pre></div></div>
	<div class="section">
	<h4>HTTP Operations Supported <a name="HTTP_Operations_Supported"></a></h4>
	<div>
	<pre> * GET</pre></div></div>
	<div class="section">
	<h4>Query Parameters Supported<a name="Query_Parameters_Supported"></a></h4>
	<div>
	<pre> None</pre></div></div>
	<div class="section">
	<h4>Elements of the <i>clusterMetrics</i> object<a name="Elements_of_the_clusterMetrics_object"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">appsSubmitted</td>
	<td align="left">int</td>
	<td align="left">The number of applications submitted</td></tr>
	<tr class="a">
	<td align="left">appsCompleted</td>
	<td align="left">int</td>
	<td align="left">The number of applications completed</td></tr>
	<tr class="b">
	<td align="left">appsPending</td>
	<td align="left">int</td>
	<td align="left">The number of applications pending</td></tr>
	<tr class="a">
	<td align="left">appsRunning</td>
	<td align="left">int</td>
	<td align="left">The number of applications running</td></tr>
	<tr class="b">
	<td align="left">appsFailed</td>
	<td align="left">int</td>
	<td align="left">The number of applications failed</td></tr>
	<tr class="a">
	<td align="left">appsKilled</td>
	<td align="left">int</td>
	<td align="left">The number of applications killed</td></tr>
	<tr class="b">
	<td align="left">reservedMB</td>
	<td align="left">long</td>
	<td align="left">The amount of memory reserved in MB</td></tr>
	<tr class="a">
	<td align="left">availableMB</td>
	<td align="left">long</td>
	<td align="left">The amount of memory available in MB</td></tr>
	<tr class="b">
	<td align="left">allocatedMB</td>
	<td align="left">long</td>
	<td align="left">The amount of memory allocated in MB</td></tr>
	<tr class="a">
	<td align="left">totalMB</td>
	<td align="left">long</td>
	<td align="left">The amount of total memory in MB</td></tr>
	<tr class="b">
	<td align="left">containersAllocated</td>
	<td align="left">int</td>
	<td align="left">The number of containers allocated</td></tr>
	<tr class="a">
	<td align="left">containersReserved</td>
	<td align="left">int</td>
	<td align="left">The number of containers reserved</td></tr>
	<tr class="b">
	<td align="left">containersPending</td>
	<td align="left">int</td>
	<td align="left">The number of containers pending</td></tr>
	<tr class="a">
	<td align="left">totalNodes</td>
	<td align="left">int</td>
	<td align="left">The total number of nodes</td></tr>
	<tr class="b">
	<td align="left">activeNodes</td>
	<td align="left">int</td>
	<td align="left">The number of active nodes</td></tr>
	<tr class="a">
	<td align="left">lostNodes</td>
	<td align="left">int</td>
	<td align="left">The number of lost nodes</td></tr>
	<tr class="b">
	<td align="left">unhealthyNodes</td>
	<td align="left">int</td>
	<td align="left">The number of unhealthy nodes</td></tr>
	<tr class="a">
	<td align="left">decommissionedNodes</td>
	<td align="left">int</td>
	<td align="left">The number of nodes decommissioned</td></tr>
	<tr class="b">
	<td align="left">rebootedNodes</td>
	<td align="left">int</td>
	<td align="left">The number of nodes rebooted</td></tr></table></div>
	<div class="section">
	<h4>Response Examples<a name="Response_Examples"></a></h4>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/metrics</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre> {
	"clusterMetrics":{
	"appsSubmitted":0,
	"appsCompleted":0,
	"appsPending":0,
	"appsRunning":0,
	"appsFailed":0,
	"appsKilled":0,
	"reservedMB":0,
	"availableMB":17408,
	"allocatedMB":0,
	"containersAllocated":0,
	"containersReserved":0,
	"containersPending":0,
	"totalMB":17408,
	"totalNodes":1,
	"lostNodes":0,
	"unhealthyNodes":0,
	"decommissionedNodes":0,
	"rebootedNodes":0,
	"activeNodes":1
	}
	}</pre></div>
	<p><b>XML response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/metrics
	Accept: application/xml</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 432
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<clusterMetrics>
	<appsSubmitted>0</appsSubmitted>
	<appsCompleted>0</appsCompleted>
	<appsPending>0</appsPending>
	<appsRunning>0</appsRunning>
	<appsFailed>0</appsFailed>
	<appsKilled>0</appsKilled>
	<reservedMB>0</reservedMB>
	<availableMB>17408</availableMB>
	<allocatedMB>0</allocatedMB>
	<containersAllocated>0</containersAllocated>
	<containersReserved>0</containersReserved>
	<containersPending>0</containersPending>
	<totalMB>17408</totalMB>
	<totalNodes>1</totalNodes>
	<lostNodes>0</lostNodes>
	<unhealthyNodes>0</unhealthyNodes>
	<decommissionedNodes>0</decommissionedNodes>
	<rebootedNodes>0</rebootedNodes>
	<activeNodes>1</activeNodes>
	</clusterMetrics></pre></div></div></div>
	<div class="section">
	<h3>Cluster Scheduler API<a name="Cluster_Scheduler_API"></a></h3>
	<p>A scheduler resource contains information about the current scheduler configured in a cluster. It currently supports both the Fifo and Capacity Scheduler. You will get different information depending on which scheduler is configured so be sure to look at the type information.</p>
	<div class="section">
	<h4>URI<a name="URI"></a></h4>
	<div>
	<pre> * http://<rm http address:port>/ws/v1/cluster/scheduler</pre></div></div>
	<div class="section">
	<h4>HTTP Operations Supported <a name="HTTP_Operations_Supported"></a></h4>
	<div>
	<pre> * GET</pre></div></div>
	<div class="section">
	<h4>Query Parameters Supported<a name="Query_Parameters_Supported"></a></h4>
	<div>
	<pre> None</pre></div></div>
	<div class="section">
	<h4>Capacity Scheduler API<a name="Capacity_Scheduler_API"></a></h4>
	<p>The capacity scheduler supports hierarchical queues. This one request will print information about all the queues and any subqueues they have. Queues that can actually have jobs submitted to them are referred to as leaf queues. These queues have additional data associated with them.</p></div>
	<div class="section">
	<h4>Elements of the <i>schedulerInfo</i> object<a name="Elements_of_the_schedulerInfo_object"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">type</td>
	<td align="left">string</td>
	<td align="left">Scheduler type - capacityScheduler</td></tr>
	<tr class="a">
	<td align="left">capacity</td>
	<td align="left">float</td>
	<td align="left">Configured queue capacity in percentage relative to its parent queue</td></tr>
	<tr class="b">
	<td align="left">usedCapacity</td>
	<td align="left">float</td>
	<td align="left">Used queue capacity in percentage</td></tr>
	<tr class="a">
	<td align="left">maxCapacity</td>
	<td align="left">float</td>
	<td align="left">Configured maximum queue capacity in percentage relative to its parent queue</td></tr>
	<tr class="b">
	<td align="left">queueName</td>
	<td align="left">string</td>
	<td align="left">Name of the queue</td></tr>
	<tr class="a">
	<td align="left">queues</td>
	<td align="left">array of queues(JSON)/zero or more queue objects(XML)</td>
	<td align="left">A collection of queue resources</td></tr></table></div>
	<div class="section">
	<h4>Elements of the queues object for a Parent queue<a name="Elements_of_the_queues_object_for_a_Parent_queue"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">capacity</td>
	<td align="left">float</td>
	<td align="left">Configured queue capacity in percentage relative to its parent queue</td></tr>
	<tr class="a">
	<td align="left">usedCapacity</td>
	<td align="left">float</td>
	<td align="left">Used queue capacity in percentage</td></tr>
	<tr class="b">
	<td align="left">maxCapacity</td>
	<td align="left">float</td>
	<td align="left">Configured maximum queue capacity in percentage relative to its parent queue</td></tr>
	<tr class="a">
	<td align="left">absoluteCapacity</td>
	<td align="left">float</td>
	<td align="left">Absolute capacity percentage this queue can use of entire cluster</td></tr>
	<tr class="b">
	<td align="left">absoluteMaxCapacity</td>
	<td align="left">float</td>
	<td align="left">Absolute maximum capacity percentage this queue can use of the entire cluster</td></tr>
	<tr class="a">
	<td align="left">absoluteUsedCapacity</td>
	<td align="left">float</td>
	<td align="left">Absolute used capacity percentage this queue is using of the entire cluster</td></tr>
	<tr class="b">
	<td align="left">numApplications</td>
	<td align="left">int</td>
	<td align="left">The number of applications currently in the queue</td></tr>
	<tr class="a">
	<td align="left">usedResources</td>
	<td align="left">string</td>
	<td align="left">A string describing the current resources used by the queue</td></tr>
	<tr class="b">
	<td align="left">queueName</td>
	<td align="left">string</td>
	<td align="left">The name of the queue</td></tr>
	<tr class="a">
	<td align="left">state</td>
	<td align="left">string of QueueState</td>
	<td align="left">The state of the queue</td></tr>
	<tr class="b">
	<td align="left">queues</td>
	<td align="left">array of queues(JSON)/zero or more queue objects(XML)</td>
	<td align="left">A collection of sub-queue information</td></tr>
	<tr class="a">
	<td align="left">resourcesUsed</td>
	<td align="left">A single resource object</td>
	<td align="left">The total amount of resources used by this queue</td></tr></table></div>
	<div class="section">
	<h4>Elements of the queues object for a Leaf queue - contains all elements in parent plus the following:<a name="Elements_of_the_queues_object_for_a_Leaf_queue_-_contains_all_elements_in_parent_plus_the_following:"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">type</td>
	<td align="left">String</td>
	<td align="left">type of the queue - capacitySchedulerLeafQueueInfo</td></tr>
	<tr class="a">
	<td align="left">numActiveApplications</td>
	<td align="left">int</td>
	<td align="left">The number of active applications in this queue</td></tr>
	<tr class="b">
	<td align="left">numPendingApplications</td>
	<td align="left">int</td>
	<td align="left">The number of pending applications in this queue</td></tr>
	<tr class="a">
	<td align="left">numContainers</td>
	<td align="left">int</td>
	<td align="left">The number of containers being used</td></tr>
	<tr class="b">
	<td align="left">maxApplications</td>
	<td align="left">int</td>
	<td align="left">The maximum number of applications this queue can have</td></tr>
	<tr class="a">
	<td align="left">maxApplicationsPerUser</td>
	<td align="left">int</td>
	<td align="left">The maximum number of applications per user this queue can have</td></tr>
	<tr class="b">
	<td align="left">maxActiveApplications</td>
	<td align="left">int</td>
	<td align="left">The maximum number of active applications this queue can have</td></tr>
	<tr class="a">
	<td align="left">maxActiveApplicationsPerUser</td>
	<td align="left">int</td>
	<td align="left">The maximum number of active applications per user this queue can have</td></tr>
	<tr class="b">
	<td align="left">userLimit</td>
	<td align="left">int</td>
	<td align="left">The minimum user limit percent set in the configuration</td></tr>
	<tr class="a">
	<td align="left">userLimitFactor</td>
	<td align="left">float</td>
	<td align="left">The user limit factor set in the configuration</td></tr>
	<tr class="b">
	<td align="left">users</td>
	<td align="left">array of users(JSON)/zero or more user objects(XML)</td>
	<td align="left">A collection of user objects containing resources used</td></tr></table></div>
	<div class="section">
	<h4>Elements of the user object for users:<a name="Elements_of_the_user_object_for_users:"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">username</td>
	<td align="left">String</td>
	<td align="left">The username of the user using the resources</td></tr>
	<tr class="a">
	<td align="left">resourcesUsed</td>
	<td align="left">A single resource object</td>
	<td align="left">The amount of resources used by the user in this queue</td></tr>
	<tr class="b">
	<td align="left">numActiveApplications</td>
	<td align="left">int</td>
	<td align="left">The number of active applications for this user in this queue</td></tr>
	<tr class="a">
	<td align="left">numPendingApplications</td>
	<td align="left">int</td>
	<td align="left">The number of pending applications for this user in this queue</td></tr></table></div>
	<div class="section">
	<h4>Elements of the resource object for resourcesUsed in user and queues:<a name="Elements_of_the_resource_object_for_resourcesUsed_in_user_and_queues:"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">memory</td>
	<td align="left">int</td>
	<td align="left">The amount of memory used (in MB)</td></tr>
	<tr class="a">
	<td align="left">vCores</td>
	<td align="left">int</td>
	<td align="left">The number of virtual cores</td></tr></table>
	<div class="section">
	<h5>Response Examples<a name="Response_Examples"></a></h5>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/scheduler</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre>{
	"scheduler": {
	"schedulerInfo": {
	"capacity": 100.0,
	"maxCapacity": 100.0,
	"queueName": "root",
	"queues": {
	"queue": [
	{
	"absoluteCapacity": 10.5,
	"absoluteMaxCapacity": 50.0,
	"absoluteUsedCapacity": 0.0,
	"capacity": 10.5,
	"maxCapacity": 50.0,
	"numApplications": 0,
	"queueName": "a",
	"queues": {
	"queue": [
	{
	"absoluteCapacity": 3.15,
	"absoluteMaxCapacity": 25.0,
	"absoluteUsedCapacity": 0.0,
	"capacity": 30.000002,
	"maxCapacity": 50.0,
	"numApplications": 0,
	"queueName": "a1",
	"queues": {
	"queue": [
	{
	"absoluteCapacity": 2.6775,
	"absoluteMaxCapacity": 25.0,
	"absoluteUsedCapacity": 0.0,
	"capacity": 85.0,
	"maxActiveApplications": 1,
	"maxActiveApplicationsPerUser": 1,
	"maxApplications": 267,
	"maxApplicationsPerUser": 267,
	"maxCapacity": 100.0,
	"numActiveApplications": 0,
	"numApplications": 0,
	"numContainers": 0,
	"numPendingApplications": 0,
	"queueName": "a1a",
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"state": "RUNNING",
	"type": "capacitySchedulerLeafQueueInfo",
	"usedCapacity": 0.0,
	"usedResources": "<memory:0, vCores:0>",
	"userLimit": 100,
	"userLimitFactor": 1.0,
	"users": null
	},
	{
	"absoluteCapacity": 0.47250003,
	"absoluteMaxCapacity": 25.0,
	"absoluteUsedCapacity": 0.0,
	"capacity": 15.000001,
	"maxActiveApplications": 1,
	"maxActiveApplicationsPerUser": 1,
	"maxApplications": 47,
	"maxApplicationsPerUser": 47,
	"maxCapacity": 100.0,
	"numActiveApplications": 0,
	"numApplications": 0,
	"numContainers": 0,
	"numPendingApplications": 0,
	"queueName": "a1b",
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"state": "RUNNING",
	"type": "capacitySchedulerLeafQueueInfo",
	"usedCapacity": 0.0,
	"usedResources": "<memory:0, vCores:0>",
	"userLimit": 100,
	"userLimitFactor": 1.0,
	"users": null
	}
	]
	},
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"state": "RUNNING",
	"usedCapacity": 0.0,
	"usedResources": "<memory:0, vCores:0>"
	},
	{
	"absoluteCapacity": 7.35,
	"absoluteMaxCapacity": 50.0,
	"absoluteUsedCapacity": 0.0,
	"capacity": 70.0,
	"maxActiveApplications": 1,
	"maxActiveApplicationsPerUser": 100,
	"maxApplications": 735,
	"maxApplicationsPerUser": 73500,
	"maxCapacity": 100.0,
	"numActiveApplications": 0,
	"numApplications": 0,
	"numContainers": 0,
	"numPendingApplications": 0,
	"queueName": "a2",
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"state": "RUNNING",
	"type": "capacitySchedulerLeafQueueInfo",
	"usedCapacity": 0.0,
	"usedResources": "<memory:0, vCores:0>",
	"userLimit": 100,
	"userLimitFactor": 100.0,
	"users": null
	}
	]
	},
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"state": "RUNNING",
	"usedCapacity": 0.0,
	"usedResources": "<memory:0, vCores:0>"
	},
	{
	"absoluteCapacity": 89.5,
	"absoluteMaxCapacity": 100.0,
	"absoluteUsedCapacity": 0.0,
	"capacity": 89.5,
	"maxCapacity": 100.0,
	"numApplications": 2,
	"queueName": "b",
	"queues": {
	"queue": [
	{
	"absoluteCapacity": 53.7,
	"absoluteMaxCapacity": 100.0,
	"absoluteUsedCapacity": 0.0,
	"capacity": 60.000004,
	"maxActiveApplications": 1,
	"maxActiveApplicationsPerUser": 100,
	"maxApplications": 5370,
	"maxApplicationsPerUser": 537000,
	"maxCapacity": 100.0,
	"numActiveApplications": 1,
	"numApplications": 2,
	"numContainers": 0,
	"numPendingApplications": 1,
	"queueName": "b1",
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"state": "RUNNING",
	"type": "capacitySchedulerLeafQueueInfo",
	"usedCapacity": 0.0,
	"usedResources": "<memory:0, vCores:0>",
	"userLimit": 100,
	"userLimitFactor": 100.0,
	"users": {
	"user": [
	{
	"numActiveApplications": 0,
	"numPendingApplications": 1,
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"username": "user2"
	},
	{
	"numActiveApplications": 1,
	"numPendingApplications": 0,
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"username": "user1"
	}
	]
	}
	},
	{
	"absoluteCapacity": 35.3525,
	"absoluteMaxCapacity": 100.0,
	"absoluteUsedCapacity": 0.0,
	"capacity": 39.5,
	"maxActiveApplications": 1,
	"maxActiveApplicationsPerUser": 100,
	"maxApplications": 3535,
	"maxApplicationsPerUser": 353500,
	"maxCapacity": 100.0,
	"numActiveApplications": 0,
	"numApplications": 0,
	"numContainers": 0,
	"numPendingApplications": 0,
	"queueName": "b2",
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"state": "RUNNING",
	"type": "capacitySchedulerLeafQueueInfo",
	"usedCapacity": 0.0,
	"usedResources": "<memory:0, vCores:0>",
	"userLimit": 100,
	"userLimitFactor": 100.0,
	"users": null
	},
	{
	"absoluteCapacity": 0.4475,
	"absoluteMaxCapacity": 100.0,
	"absoluteUsedCapacity": 0.0,
	"capacity": 0.5,
	"maxActiveApplications": 1,
	"maxActiveApplicationsPerUser": 100,
	"maxApplications": 44,
	"maxApplicationsPerUser": 4400,
	"maxCapacity": 100.0,
	"numActiveApplications": 0,
	"numApplications": 0,
	"numContainers": 0,
	"numPendingApplications": 0,
	"queueName": "b3",
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"state": "RUNNING",
	"type": "capacitySchedulerLeafQueueInfo",
	"usedCapacity": 0.0,
	"usedResources": "<memory:0, vCores:0>",
	"userLimit": 100,
	"userLimitFactor": 100.0,
	"users": null
	}
	]
	},
	"resourcesUsed": {
	"memory": 0,
	"vCores": 0
	},
	"state": "RUNNING",
	"usedCapacity": 0.0,
	"usedResources": "<memory:0, vCores:0>"
	}
	]
	},
	"type": "capacityScheduler",
	"usedCapacity": 0.0
	}
	}
	}</pre></div>
	<p><b>XML response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> Accept: application/xml
	GET http://<rm http address:port>/ws/v1/cluster/scheduler</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 5778
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<scheduler>
	<schedulerInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="capacityScheduler">
	<capacity>100.0</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>100.0</maxCapacity>
	<queueName>root</queueName>
	<queues>
	<queue>
	<capacity>10.5</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>50.0</maxCapacity>
	<absoluteCapacity>10.5</absoluteCapacity>
	<absoluteMaxCapacity>50.0</absoluteMaxCapacity>
	<absoluteUsedCapacity>0.0</absoluteUsedCapacity>
	<numApplications>0</numApplications>
	<usedResources>&lt;memory:0, vCores:0&gt;</usedResources>
	<queueName>a</queueName>
	<state>RUNNING</state>
	<queues>
	<queue>
	<capacity>30.000002</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>50.0</maxCapacity>
	<absoluteCapacity>3.15</absoluteCapacity>
	<absoluteMaxCapacity>25.0</absoluteMaxCapacity>
	<absoluteUsedCapacity>0.0</absoluteUsedCapacity>
	<numApplications>0</numApplications>
	<usedResources>&lt;memory:0, vCores:0&gt;</usedResources>
	<queueName>a1</queueName>
	<state>RUNNING</state>
	<queues>
	<queue xsi:type="capacitySchedulerLeafQueueInfo">
	<capacity>85.0</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>100.0</maxCapacity>
	<absoluteCapacity>2.6775</absoluteCapacity>
	<absoluteMaxCapacity>25.0</absoluteMaxCapacity>
	<absoluteUsedCapacity>0.0</absoluteUsedCapacity>
	<numApplications>0</numApplications>
	<usedResources>&lt;memory:0, vCores:0&gt;</usedResources>
	<queueName>a1a</queueName>
	<state>RUNNING</state>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	<numActiveApplications>0</numActiveApplications>
	<numPendingApplications>0</numPendingApplications>
	<numContainers>0</numContainers>
	<maxApplications>267</maxApplications>
	<maxApplicationsPerUser>267</maxApplicationsPerUser>
	<maxActiveApplications>1</maxActiveApplications>
	<maxActiveApplicationsPerUser>1</maxActiveApplicationsPerUser>
	<userLimit>100</userLimit>
	<users/>
	<userLimitFactor>1.0</userLimitFactor>
	</queue>
	<queue xsi:type="capacitySchedulerLeafQueueInfo">
	<capacity>15.000001</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>100.0</maxCapacity>
	<absoluteCapacity>0.47250003</absoluteCapacity>
	<absoluteMaxCapacity>25.0</absoluteMaxCapacity>
	<absoluteUsedCapacity>0.0</absoluteUsedCapacity>
	<numApplications>0</numApplications>
	<usedResources>&lt;memory:0, vCores:0&gt;</usedResources>
	<queueName>a1b</queueName>
	<state>RUNNING</state>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	<numActiveApplications>0</numActiveApplications>
	<numPendingApplications>0</numPendingApplications>
	<numContainers>0</numContainers>
	<maxApplications>47</maxApplications>
	<maxApplicationsPerUser>47</maxApplicationsPerUser>
	<maxActiveApplications>1</maxActiveApplications>
	<maxActiveApplicationsPerUser>1</maxActiveApplicationsPerUser>
	<userLimit>100</userLimit>
	<users/>
	<userLimitFactor>1.0</userLimitFactor>
	</queue>
	</queues>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	</queue>
	<queue xsi:type="capacitySchedulerLeafQueueInfo">
	<capacity>70.0</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>100.0</maxCapacity>
	<absoluteCapacity>7.35</absoluteCapacity>
	<absoluteMaxCapacity>50.0</absoluteMaxCapacity>
	<absoluteUsedCapacity>0.0</absoluteUsedCapacity>
	<numApplications>0</numApplications>
	<usedResources>&lt;memory:0, vCores:0&gt;</usedResources>
	<queueName>a2</queueName>
	<state>RUNNING</state>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	<numActiveApplications>0</numActiveApplications>
	<numPendingApplications>0</numPendingApplications>
	<numContainers>0</numContainers>
	<maxApplications>735</maxApplications>
	<maxApplicationsPerUser>73500</maxApplicationsPerUser>
	<maxActiveApplications>1</maxActiveApplications>
	<maxActiveApplicationsPerUser>100</maxActiveApplicationsPerUser>
	<userLimit>100</userLimit>
	<users/>
	<userLimitFactor>100.0</userLimitFactor>
	</queue>
	</queues>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	</queue>
	<queue>
	<capacity>89.5</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>100.0</maxCapacity>
	<absoluteCapacity>89.5</absoluteCapacity>
	<absoluteMaxCapacity>100.0</absoluteMaxCapacity>
	<absoluteUsedCapacity>0.0</absoluteUsedCapacity>
	<numApplications>2</numApplications>
	<usedResources>&lt;memory:0, vCores:0&gt;</usedResources>
	<queueName>b</queueName>
	<state>RUNNING</state>
	<queues>
	<queue xsi:type="capacitySchedulerLeafQueueInfo">
	<capacity>60.000004</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>100.0</maxCapacity>
	<absoluteCapacity>53.7</absoluteCapacity>
	<absoluteMaxCapacity>100.0</absoluteMaxCapacity>
	<absoluteUsedCapacity>0.0</absoluteUsedCapacity>
	<numApplications>2</numApplications>
	<usedResources>&lt;memory:0, vCores:0&gt;</usedResources>
	<queueName>b1</queueName>
	<state>RUNNING</state>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	<numActiveApplications>1</numActiveApplications>
	<numPendingApplications>1</numPendingApplications>
	<numContainers>0</numContainers>
	<maxApplications>5370</maxApplications>
	<maxApplicationsPerUser>537000</maxApplicationsPerUser>
	<maxActiveApplications>1</maxActiveApplications>
	<maxActiveApplicationsPerUser>100</maxActiveApplicationsPerUser>
	<userLimit>100</userLimit>
	<users>
	<user>
	<username>user2</username>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	<numPendingApplications>1</numPendingApplications>
	<numActiveApplications>0</numActiveApplications>
	</user>
	<user>
	<username>user1</username>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	<numPendingApplications>0</numPendingApplications>
	<numActiveApplications>1</numActiveApplications>
	</user>
	</users>
	<userLimitFactor>100.0</userLimitFactor>
	</queue>
	<queue xsi:type="capacitySchedulerLeafQueueInfo">
	<capacity>39.5</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>100.0</maxCapacity>
	<absoluteCapacity>35.3525</absoluteCapacity>
	<absoluteMaxCapacity>100.0</absoluteMaxCapacity>
	<absoluteUsedCapacity>0.0</absoluteUsedCapacity>
	<numApplications>0</numApplications>
	<usedResources>&lt;memory:0, vCores:0&gt;</usedResources>
	<queueName>b2</queueName>
	<state>RUNNING</state>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	<numActiveApplications>0</numActiveApplications>
	<numPendingApplications>0</numPendingApplications>
	<numContainers>0</numContainers>
	<maxApplications>3535</maxApplications>
	<maxApplicationsPerUser>353500</maxApplicationsPerUser>
	<maxActiveApplications>1</maxActiveApplications>
	<maxActiveApplicationsPerUser>100</maxActiveApplicationsPerUser>
	<userLimit>100</userLimit>
	<users/>
	<userLimitFactor>100.0</userLimitFactor>
	</queue>
	<queue xsi:type="capacitySchedulerLeafQueueInfo">
	<capacity>0.5</capacity>
	<usedCapacity>0.0</usedCapacity>
	<maxCapacity>100.0</maxCapacity>
	<absoluteCapacity>0.4475</absoluteCapacity>
	<absoluteMaxCapacity>100.0</absoluteMaxCapacity>
	<absoluteUsedCapacity>0.0</absoluteUsedCapacity>
	<numApplications>0</numApplications>
	<usedResources>&lt;memory:0, vCores:0&gt;</usedResources>
	<queueName>b3</queueName>
	<state>RUNNING</state>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	<numActiveApplications>0</numActiveApplications>
	<numPendingApplications>0</numPendingApplications>
	<numContainers>0</numContainers>
	<maxApplications>44</maxApplications>
	<maxApplicationsPerUser>4400</maxApplicationsPerUser>
	<maxActiveApplications>1</maxActiveApplications>
	<maxActiveApplicationsPerUser>100</maxActiveApplicationsPerUser>
	<userLimit>100</userLimit>
	<users/>
	<userLimitFactor>100.0</userLimitFactor>
	</queue>
	</queues>
	<resourcesUsed>
	<memory>0</memory>
	<vCores>0</vCores>
	</resourcesUsed>
	</queue>
	</queues>
	</schedulerInfo>
	</scheduler></pre></div></div></div>
	<div class="section">
	<h4>Fifo Scheduler API<a name="Fifo_Scheduler_API"></a></h4></div>
	<div class="section">
	<h4>Elements of the <i>schedulerInfo</i> object<a name="Elements_of_the_schedulerInfo_object"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">type</td>
	<td align="left">string</td>
	<td align="left">Scheduler type - fifoScheduler</td></tr>
	<tr class="a">
	<td align="left">capacity</td>
	<td align="left">float</td>
	<td align="left">Queue capacity in percentage</td></tr>
	<tr class="b">
	<td align="left">usedCapacity</td>
	<td align="left">float</td>
	<td align="left">Used queue capacity in percentage</td></tr>
	<tr class="a">
	<td align="left">qstate</td>
	<td align="left">string</td>
	<td align="left">State of the queue - valid values are: STOPPED, RUNNING</td></tr>
	<tr class="b">
	<td align="left">minQueueMemoryCapacity</td>
	<td align="left">int</td>
	<td align="left">Minimum queue memory capacity</td></tr>
	<tr class="a">
	<td align="left">maxQueueMemoryCapacity</td>
	<td align="left">int</td>
	<td align="left">Maximum queue memory capacity</td></tr>
	<tr class="b">
	<td align="left">numNodes</td>
	<td align="left">int</td>
	<td align="left">The total number of nodes</td></tr>
	<tr class="a">
	<td align="left">usedNodeCapacity</td>
	<td align="left">int</td>
	<td align="left">The used node capacity</td></tr>
	<tr class="b">
	<td align="left">availNodeCapacity</td>
	<td align="left">int</td>
	<td align="left">The available node capacity</td></tr>
	<tr class="a">
	<td align="left">totalNodeCapacity</td>
	<td align="left">int</td>
	<td align="left">The total node capacity</td></tr>
	<tr class="b">
	<td align="left">numContainers</td>
	<td align="left">int</td>
	<td align="left">The number of containers</td></tr></table>
	<div class="section">
	<h5>Response Examples<a name="Response_Examples"></a></h5>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/scheduler</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre>{
	"scheduler":
	{
	"schedulerInfo":
	{
	"type":"fifoScheduler",
	"capacity":1,
	"usedCapacity":"NaN",
	"qstate":"RUNNING",
	"minQueueMemoryCapacity":1024,
	"maxQueueMemoryCapacity":10240,
	"numNodes":0,
	"usedNodeCapacity":0,
	"availNodeCapacity":0,
	"totalNodeCapacity":0,
	"numContainers":0
	}
	}
	}</pre></div>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/scheduler
	Accept: application/xml</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 432
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<scheduler>
	<schedulerInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="fifoScheduler">
	<capacity>1.0</capacity>
	<usedCapacity>NaN</usedCapacity>
	<qstate>RUNNING</qstate>
	<minQueueMemoryCapacity>1024</minQueueMemoryCapacity>
	<maxQueueMemoryCapacity>10240</maxQueueMemoryCapacity>
	<numNodes>0</numNodes>
	<usedNodeCapacity>0</usedNodeCapacity>
	<availNodeCapacity>0</availNodeCapacity>
	<totalNodeCapacity>0</totalNodeCapacity>
	<numContainers>0</numContainers>
	</schedulerInfo>
	</scheduler></pre></div></div></div></div>
	<div class="section">
	<h3>Cluster Applications API<a name="Cluster_Applications_API"></a></h3>
	<p>With the Applications API, you can obtain a collection of resources, each of which represents an application. When you run a GET operation on this resource, you obtain a collection of Application Objects. </p>
	<div class="section">
	<h4>URI<a name="URI"></a></h4>
	<div>
	<pre> * http://<rm http address:port>/ws/v1/cluster/apps</pre></div></div>
	<div class="section">
	<h4>HTTP Operations Supported <a name="HTTP_Operations_Supported"></a></h4>
	<div>
	<pre> * GET</pre></div></div>
	<div class="section">
	<h4>Query Parameters Supported<a name="Query_Parameters_Supported"></a></h4>
	<p>Multiple parameters can be specified. The started and finished times have a begin and end parameter to allow you to specify ranges. For example, one could request all applications that started between 1:00am and 2:00pm on 12/19/2011 with startedTimeBegin=1324256400&startedTimeEnd=1324303200. If the Begin parameter is not specified, it defaults to 0, and if the End parameter is not specified, it defaults to infinity.</p>
	<div>
	<pre> * state [deprecated] - state of the application
	* states - applications matching the given application states, specified as a comma-separated list.
	* finalStatus - the final status of the application - reported by the application itself
	* user - user name
	* queue - queue name
	* limit - total number of app objects to be returned
	* startedTimeBegin - applications with start time beginning with this time, specified in ms since epoch
	* startedTimeEnd - applications with start time ending with this time, specified in ms since epoch
	* finishedTimeBegin - applications with finish time beginning with this time, specified in ms since epoch
	* finishedTimeEnd - applications with finish time ending with this time, specified in ms since epoch
	* applicationTypes - applications matching the given application types, specified as a comma-separated list.</pre></div></div>
	<div class="section">
	<h4>Elements of the <i>apps</i> (Applications) object<a name="Elements_of_the_apps_Applications_object"></a></h4>
	<p>When you make a request for the list of applications, the information will be returned as a collection of app objects. See also <a href="#Application_API">Application API</a> for syntax of the app object.</p>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">app</td>
	<td align="left">array of app objects(JSON)/zero or more application objects(XML)</td>
	<td align="left">The collection of application objects</td></tr></table></div>
	<div class="section">
	<h4>Response Examples<a name="Response_Examples"></a></h4>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/apps</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre>{
	"apps":
	{
	"app":
	[
	{
	"finishedTime" : 1326815598530,
	"amContainerLogs" : "http://host.domain.com:8042/node/containerlogs/container_1326815542473_0001_01_000001",
	"trackingUI" : "History",
	"state" : "FINISHED",
	"user" : "user1",
	"id" : "application_1326815542473_0001",
	"clusterId" : 1326815542473,
	"finalStatus" : "SUCCEEDED",
	"amHostHttpAddress" : "host.domain.com:8042",
	"progress" : 100,
	"name" : "word count",
	"startedTime" : 1326815573334,
	"elapsedTime" : 25196,
	"diagnostics" : "",
	"trackingUrl" : "http://host.domain.com:8088/proxy/application_1326815542473_0001/jobhistory/job/job_1326815542473_1_1",
	"queue" : "default",
	"allocatedMB" : 0,
	"allocatedVCores" : 0,
	"runningContainers" : 0
	},
	{
	"finishedTime" : 1326815789546,
	"amContainerLogs" : "http://host.domain.com:8042/node/containerlogs/container_1326815542473_0002_01_000001",
	"trackingUI" : "History",
	"state" : "FINISHED",
	"user" : "user1",
	"id" : "application_1326815542473_0002",
	"clusterId" : 1326815542473,
	"finalStatus" : "SUCCEEDED",
	"amHostHttpAddress" : "host.domain.com:8042",
	"progress" : 100,
	"name" : "Sleep job",
	"startedTime" : 1326815641380,
	"elapsedTime" : 148166,
	"diagnostics" : "",
	"trackingUrl" : "http://host.domain.com:8088/proxy/application_1326815542473_0002/jobhistory/job/job_1326815542473_2_2",
	"queue" : "default",
	"allocatedMB" : 0,
	"allocatedVCores" : 0,
	"runningContainers" : 1
	}
	]
	}
	}</pre></div>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/apps
	Accept: application/xml</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 2459
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<apps>
	<app>
	<id>application_1326815542473_0001</id>
	<user>user1</user>
	<name>word count</name>
	<applicationType>MAPREDUCE</applicationType>
	<queue>default</queue>
	<state>FINISHED</state>
	<finalStatus>SUCCEEDED</finalStatus>
	<progress>100.0</progress>
	<trackingUI>History</trackingUI>
	<trackingUrl>http://host.domain.com:8088/proxy/application_1326815542473_0001/jobhistory/job
	/job_1326815542473_1_1</trackingUrl>
	<diagnostics/>
	<clusterId>1326815542473</clusterId>
	<startedTime>1326815573334</startedTime>
	<finishedTime>1326815598530</finishedTime>
	<elapsedTime>25196</elapsedTime>
	<amContainerLogs>http://host.domain.com:8042/node/containerlogs/container_1326815542473_0001
	_01_000001</amContainerLogs>
	<amHostHttpAddress>host.domain.com:8042</amHostHttpAddress>
	<allocatedMB>0</allocatedMB>
	<allocatedVCores>0</allocatedVCores>
	<runningContainers>0</runningContainers>
	</app>
	<app>
	<id>application_1326815542473_0002</id>
	<user>user1</user>
	<name>Sleep job</name>
	<applicationType>YARN</applicationType>
	<queue>default</queue>
	<state>FINISHED</state>
	<finalStatus>SUCCEEDED</finalStatus>
	<progress>100.0</progress>
	<trackingUI>History</trackingUI>
	<trackingUrl>http://host.domain.com:8088/proxy/application_1326815542473_0002/jobhistory/job/job_1326815542473_2_2</trackingUrl>
	<diagnostics/>
	<clusterId>1326815542473</clusterId>
	<startedTime>1326815641380</startedTime>
	<finishedTime>1326815789546</finishedTime>
	<elapsedTime>148166</elapsedTime>
	<amContainerLogs>http://host.domain.com:8042/node/containerlogs/container_1326815542473_0002_01_000001</amContainerLogs>
	<amHostHttpAddress>host.domain.com:8042</amHostHttpAddress>
	<allocatedMB>0</allocatedMB>
	<allocatedVCores>0</allocatedVCores>
	<runningContainers>0</runningContainers>
	</app>
	</apps>
	</pre></div></div></div>
	<div class="section">
	<h3>Cluster Application Statistics API<a name="Cluster_Application_Statistics_API"></a></h3>
	<p>With the Application Statistics API, you can obtain a collection of triples, each of which contains the application type, the application state and the number of applications of this type and this state in ResourceManager context. Note that with the performance concern, we currently only support at most one applicationType per query. We may support multiple applicationTypes per query as well as more statistics in the future. When you run a GET operation on this resource, you obtain a collection of statItem objects. </p>
	<div class="section">
	<h4>URI<a name="URI"></a></h4>
	<div>
	<pre> * http://<rm http address:port>/ws/v1/cluster/appstatistics</pre></div></div>
	<div class="section">
	<h4>HTTP Operations Supported<a name="HTTP_Operations_Supported"></a></h4>
	<div>
	<pre> * GET</pre></div></div>
	<div class="section">
	<h4>Query Parameters Required<a name="Query_Parameters_Required"></a></h4>
	<p>Two paramters can be specified. The parameters are case insensitive.</p>
	<div>
	<pre> * states - states of the applications, specified as a comma-separated list. If states is not provided, the API will enumerate all application states and return the counts of them.
	* applicationTypes - types of the applications, specified as a comma-separated list. If applicationTypes is not provided, the API will count the applications of any application type. In this case, the response shows * to indicate any application type. Note that we only support at most one applicationType temporarily. Otherwise, users will expect an BadRequestException.</pre></div></div>
	<div class="section">
	<h4>Elements of the <i>appStatInfo</i> (statItems) object<a name="Elements_of_the_appStatInfo_statItems_object"></a></h4>
	<p>When you make a request for the list of statistics items, the information will be returned as a collection of statItem objects</p>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">statItem</td>
	<td align="left">array of statItem objects(JSON)/zero or more statItem objects(XML)</td>
	<td align="left">The collection of statItem objects</td></tr></table></div>
	<div class="section">
	<h4>Response Examples<a name="Response_Examples"></a></h4>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/appstatistics?states=accepted,running,finished&applicationTypes=mapreduce</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre>{
	"appStatInfo":
	{
	"statItem":
	[
	{
	"state" : "accepted",
	"type" : "mapreduce",
	"count" : 4
	},
	{
	"state" : "running",
	"type" : "mapreduce",
	"count" : 1
	},
	{
	"state" : "finished",
	"type" : "mapreduce",
	"count" : 7
	}
	]
	}
	}</pre></div>
	<p><b>XML response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/appstatistics?states=accepted,running,finished&applicationTypes=mapreduce
	Accept: application/xml</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 2459
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<appStatInfo>
	<statItem>
	<state>accepted</state>
	<type>mapreduce</type>
	<count>4</count>
	</statItem>
	<statItem>
	<state>running</state>
	<type>mapreduce</type>
	<count>1</count>
	</statItem>
	<statItem>
	<state>finished</state>
	<type>mapreduce</type>
	<count>7</count>
	</statItem>
	</appStatInfo></pre></div></div></div>
	<div class="section">
	<h3>Cluster <a name="Application_API">Application API</a><a name="Cluster_Application_API"></a></h3>
	<p>An application resource contains information about a particular application that was submitted to a cluster.</p>
	<div class="section">
	<h4>URI<a name="URI"></a></h4>
	<p>Use the following URI to obtain an app object, from a application identified by the <a name="appid">appid</a> value. </p>
	<div>
	<pre> * http://<rm http address:port>/ws/v1/cluster/apps/{appid}</pre></div></div>
	<div class="section">
	<h4>HTTP Operations Supported <a name="HTTP_Operations_Supported"></a></h4>
	<div>
	<pre> * GET</pre></div></div>
	<div class="section">
	<h4>Query Parameters Supported<a name="Query_Parameters_Supported"></a></h4>
	<div>
	<pre> None</pre></div></div>
	<div class="section">
	<h4>Elements of the <i>app</i> (Application) object<a name="Elements_of_the_app_Application_object"></a></h4>
	<p>Note that depending on security settings a user might not be able to see all the fields. </p>
	<table border="1" class="bodyTable"><caption>\| allocatedVCores \| int \| The sum of virtual cores allocated to the application's running containers \| +---------------------------------------------------------------+ \| runningContainers \| int \| The number of containers currently running for the application \| +---------------------------------------------------------------+</caption>
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">id</td>
	<td align="left">string</td>
	<td align="left">The application id</td></tr>
	<tr class="a">
	<td align="left">user</td>
	<td align="left">string</td>
	<td align="left">The user who started the application</td></tr>
	<tr class="b">
	<td align="left">name</td>
	<td align="left">string</td>
	<td align="left">The application name</td></tr>
	<tr class="a">
	<td align="left">Application Type</td>
	<td align="left">string</td>
	<td align="left">The application type</td></tr>
	<tr class="b">
	<td align="left">queue</td>
	<td align="left">string</td>
	<td align="left">The queue the application was submitted to</td></tr>
	<tr class="a">
	<td align="left">state</td>
	<td align="left">string</td>
	<td align="left">The application state according to the ResourceManager - valid values are members of the YarnApplicationState enum: NEW, NEW_SAVING, SUBMITTED, ACCEPTED, RUNNING, FINISHED, FAILED, KILLED</td></tr>
	<tr class="b">
	<td align="left">finalStatus</td>
	<td align="left">string</td>
	<td align="left">The final status of the application if finished - reported by the application itself - valid values are: UNDEFINED, SUCCEEDED, FAILED, KILLED</td></tr>
	<tr class="a">
	<td align="left">progress</td>
	<td align="left">float</td>
	<td align="left">The progress of the application as a percent</td></tr>
	<tr class="b">
	<td align="left">trackingUI</td>
	<td align="left">string</td>
	<td align="left">Where the tracking url is currently pointing - History (for history server) or ApplicationMaster</td></tr>
	<tr class="a">
	<td align="left">trackingUrl</td>
	<td align="left">string</td>
	<td align="left">The web URL that can be used to track the application</td></tr>
	<tr class="b">
	<td align="left">diagnostics</td>
	<td align="left">string</td>
	<td align="left">Detailed diagnostics information</td></tr>
	<tr class="a">
	<td align="left">clusterId</td>
	<td align="left">long</td>
	<td align="left">The cluster id</td></tr>
	<tr class="b">
	<td align="left">startedTime</td>
	<td align="left">long</td>
	<td align="left">The time in which application started (in ms since epoch)</td></tr>
	<tr class="a">
	<td align="left">finishedTime</td>
	<td align="left">long</td>
	<td align="left">The time in which the application finished (in ms since epoch)</td></tr>
	<tr class="b">
	<td align="left">elapsedTime</td>
	<td align="left">long</td>
	<td align="left">The elapsed time since the application started (in ms)</td></tr>
	<tr class="a">
	<td align="left">amContainerLogs</td>
	<td align="left">string</td>
	<td align="left">The URL of the application master container logs</td></tr>
	<tr class="b">
	<td align="left">amHostHttpAddress</td>
	<td align="left">string</td>
	<td align="left">The nodes http address of the application master</td></tr>
	<tr class="a">
	<td align="left">allocatedMB</td>
	<td align="left">int</td>
	<td align="left">The sum of memory in MB allocated to the application's running containers</td></tr></table></div>
	<div class="section">
	<h4>Response Examples<a name="Response_Examples"></a></h4>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/apps/application_1326821518301_0005</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre>{
	"app" : {
	"finishedTime" : 1326824991300,
	"amContainerLogs" : "http://host.domain.com:8042/node/containerlogs/container_1326821518301_0005_01_000001",
	"trackingUI" : "History",
	"state" : "FINISHED",
	"user" : "user1",
	"id" : "application_1326821518301_0005",
	"clusterId" : 1326821518301,
	"finalStatus" : "SUCCEEDED",
	"amHostHttpAddress" : "host.domain.com:8042",
	"progress" : 100,
	"name" : "Sleep job",
	"applicationType" : "Yarn",
	"startedTime" : 1326824544552,
	"elapsedTime" : 446748,
	"diagnostics" : "",
	"trackingUrl" : "http://host.domain.com:8088/proxy/application_1326821518301_0005/jobhistory/job/job_1326821518301_5_5",
	"queue" : "a1"
	}
	}</pre></div>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/apps/application_1326821518301_0005
	Accept: application/xml</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 847
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<app>
	<id>application_1326821518301_0005</id>
	<user>user1</user>
	<name>Sleep job</name>
	<queue>a1</queue>
	<state>FINISHED</state>
	<finalStatus>SUCCEEDED</finalStatus>
	<progress>100.0</progress>
	<trackingUI>History</trackingUI>
	<trackingUrl>http://host.domain.com:8088/proxy/application_1326821518301_0005/jobhistory/job/job_1326821518301_5_5</trackingUrl>
	<diagnostics/>
	<clusterId>1326821518301</clusterId>
	<startedTime>1326824544552</startedTime>
	<finishedTime>1326824991300</finishedTime>
	<elapsedTime>446748</elapsedTime>
	<amContainerLogs>http://host.domain.com:8042/node/containerlogs/container_1326821518301_0005_01_000001</amContainerLogs>
	<amHostHttpAddress>host.domain.com:8042</amHostHttpAddress>
	</app></pre></div></div></div>
	<div class="section">
	<h3>Cluster Application Attempts API<a name="Cluster_Application_Attempts_API"></a></h3>
	<p>With the application attempts API, you can obtain a collection of resources that represent an application attempt. When you run a GET operation on this resource, you obtain a collection of App Attempt Objects. </p>
	<div class="section">
	<h4>URI<a name="URI"></a></h4>
	<div>
	<pre> * http://<rm http address:port>/ws/v1/cluster/apps/{appid}/appattempts</pre></div></div>
	<div class="section">
	<h4>HTTP Operations Supported <a name="HTTP_Operations_Supported"></a></h4>
	<div>
	<pre> * GET</pre></div></div>
	<div class="section">
	<h4>Query Parameters Supported<a name="Query_Parameters_Supported"></a></h4>
	<div>
	<pre> None</pre></div></div>
	<div class="section">
	<h4>Elements of the <i>appAttempts</i> object<a name="Elements_of_the_appAttempts_object"></a></h4>
	<p>When you make a request for the list of app attempts, the information will be returned as an array of app attempt objects. </p>
	<p>appAttempts:</p>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">appAttempt</td>
	<td align="left">array of app attempt objects(JSON)/zero or more app attempt objects(XML)</td>
	<td align="left">The collection of app attempt objects</td></tr></table></div>
	<div class="section">
	<h4>Elements of the <i>appAttempt</i> object<a name="Elements_of_the_appAttempt_object"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">id</td>
	<td align="left">string</td>
	<td align="left">The app attempt id</td></tr>
	<tr class="a">
	<td align="left">nodeId</td>
	<td align="left">string</td>
	<td align="left">The node id of the node the attempt ran on</td></tr>
	<tr class="b">
	<td align="left">nodeHttpAddress</td>
	<td align="left">string</td>
	<td align="left">The node http address of the node the attempt ran on</td></tr>
	<tr class="a">
	<td align="left">logsLink</td>
	<td align="left">string</td>
	<td align="left">The http link to the app attempt logs</td></tr>
	<tr class="b">
	<td align="left">containerId</td>
	<td align="left">string</td>
	<td align="left">The id of the container for the app attempt</td></tr>
	<tr class="a">
	<td align="left">startTime</td>
	<td align="left">long</td>
	<td align="left">The start time of the attempt (in ms since epoch)</td></tr></table></div>
	<div class="section">
	<h4>Response Examples<a name="Response_Examples"></a></h4>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/apps/application_1326821518301_0005/appattempts</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre>{
	"appAttempts" : {
	"appAttempt" : [
	{
	"nodeId" : "host.domain.com:8041",
	"nodeHttpAddress" : "host.domain.com:8042",
	"startTime" : 1326381444693,
	"id" : 1,
	"logsLink" : "http://host.domain.com:8042/node/containerlogs/container_1326821518301_0005_01_000001/user1",
	"containerId" : "container_1326821518301_0005_01_000001"
	}
	]
	}
	}</pre></div>
	<p><b>XML response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/apps/application_1326821518301_0005/appattempts
	Accept: application/xml</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 575
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<appAttempts>
	<appttempt>
	<nodeHttpAddress>host.domain.com:8042</nodeHttpAddress>
	<nodeId>host.domain.com:8041</nodeId>
	<id>1</id>
	<startTime>1326381444693</startTime>
	<containerId>container_1326821518301_0005_01_000001</containerId>
	<logsLink>http://host.domain.com:8042/node/containerlogs/container_1326821518301_0005_01_000001/user1</logsLink>
	</appAttempt>
	</appAttempts></pre></div></div></div>
	<div class="section">
	<h3>Cluster Nodes API<a name="Cluster_Nodes_API"></a></h3>
	<p>With the Nodes API, you can obtain a collection of resources, each of which represents a node. When you run a GET operation on this resource, you obtain a collection of Node Objects. </p>
	<div class="section">
	<h4>URI<a name="URI"></a></h4>
	<div>
	<pre> * http://<rm http address:port>/ws/v1/cluster/nodes</pre></div></div>
	<div class="section">
	<h4>HTTP Operations Supported <a name="HTTP_Operations_Supported"></a></h4>
	<div>
	<pre> * GET</pre></div></div>
	<div class="section">
	<h4>Query Parameters Supported<a name="Query_Parameters_Supported"></a></h4>
	<div>
	<pre> * state - the state of the node
	* healthy - true or false </pre></div></div>
	<div class="section">
	<h4>Elements of the <i>nodes</i> object<a name="Elements_of_the_nodes_object"></a></h4>
	<p>When you make a request for the list of nodes, the information will be returned as a collection of node objects. See also <a href="#Node_API">Node API</a> for syntax of the node object.</p>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">node</td>
	<td align="left">array of node objects(JSON)/zero or more node objects(XML)</td>
	<td align="left">A collection of node objects</td></tr></table></div>
	<div class="section">
	<h4>Response Examples<a name="Response_Examples"></a></h4>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/nodes</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre>{
	"nodes":
	{
	"node":
	[
	{
	"rack":"\/default-rack",
	"state":"NEW",
	"id":"h2:1235",
	"nodeHostName":"h2",
	"nodeHTTPAddress":"h2:2",
	"healthStatus":"Healthy",
	"lastHealthUpdate":1324056895432,
	"healthReport":"Healthy",
	"numContainers":0,
	"usedMemoryMB":0
	"availMemoryMB":8192
	},
	{
	"rack":"\/default-rack",
	"state":"NEW",
	"id":"h1:1234",
	"nodeHostName":"h1",
	"nodeHTTPAddress":"h1:2",
	"healthStatus":"Healthy",
	"lastHealthUpdate":1324056895092,
	"healthReport":"Healthy",
	"numContainers":0,
	"usedMemoryMB":0,
	"availMemoryMB":8192
	}
	]
	}
	}</pre></div>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/nodes
	Accept: application/xml</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 1104
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<nodes>
	<node>
	<rack>/default-rack</rack>
	<state>RUNNING</state>
	<id>h2:1234</id>
	<nodeHostName>h2</nodeHostName>
	<nodeHTTPAddress>h2:2</nodeHTTPAddress>
	<healthStatus>Healthy</healthStatus>
	<lastHealthUpdate>1324333268447</lastHealthUpdate>
	<healthReport>Healthy</healthReport>
	<numContainers>0</numContainers>
	<usedMemoryMB>0</usedMemoryMB>
	<availMemoryMB>5120</availMemoryMB>
	</node>
	<node>
	<rack>/default-rack</rack>
	<state>RUNNING</state>
	<id>h1:1234</id>
	<nodeHostName>h1</nodeHostName>
	<nodeHTTPAddress>h1:2</nodeHTTPAddress>
	<healthStatus>Healthy</healthStatus>
	<lastHealthUpdate>1324333268447</lastHealthUpdate>
	<healthReport>Healthy</healthReport>
	<numContainers>0</numContainers>
	<usedMemoryMB>0</usedMemoryMB>
	<availMemoryMB>5120</availMemoryMB>
	</node>
	</nodes></pre></div></div></div>
	<div class="section">
	<h3>Cluster <a name="Node_API">Node API</a><a name="Cluster_Node_API"></a></h3>
	<p>A node resource contains information about a node in the cluster. </p>
	<div class="section">
	<h4>URI<a name="URI"></a></h4>
	<p>Use the following URI to obtain a Node Object, from a node identified by the <a name="nodeid">nodeid</a> value. </p>
	<div>
	<pre> * http://<rm http address:port>/ws/v1/cluster/nodes/{nodeid}</pre></div></div>
	<div class="section">
	<h4>HTTP Operations Supported <a name="HTTP_Operations_Supported"></a></h4>
	<div>
	<pre> * GET</pre></div></div>
	<div class="section">
	<h4>Query Parameters Supported<a name="Query_Parameters_Supported"></a></h4>
	<div>
	<pre> None</pre></div></div>
	<div class="section">
	<h4>Elements of the <i>node</i> object<a name="Elements_of_the_node_object"></a></h4>
	<table border="1" class="bodyTable">
	<tr class="a">
	<th align="left">Item</th>
	<th align="left">Data Type</th>
	<th align="left">Description</th></tr>
	<tr class="b">
	<td align="left">rack</td>
	<td align="left">string</td>
	<td align="left">The rack location of this node</td></tr>
	<tr class="a">
	<td align="left">state</td>
	<td align="left">string</td>
	<td align="left">State of the node - valid values are: NEW, RUNNING, UNHEALTHY, DECOMMISSIONED, LOST, REBOOTED</td></tr>
	<tr class="b">
	<td align="left">id</td>
	<td align="left">string</td>
	<td align="left">The node id</td></tr>
	<tr class="a">
	<td align="left">nodeHostName</td>
	<td align="left">string</td>
	<td align="left">The host name of the node</td></tr>
	<tr class="b">
	<td align="left">nodeHTTPAddress</td>
	<td align="left">string</td>
	<td align="left">The nodes HTTP address</td></tr>
	<tr class="a">
	<td align="left">healthStatus</td>
	<td align="left">string</td>
	<td align="left">The health status of the node - Healthy or Unhealthy</td></tr>
	<tr class="b">
	<td align="left">healthReport</td>
	<td align="left">string</td>
	<td align="left">A detailed health report</td></tr>
	<tr class="a">
	<td align="left">lastHealthUpdate</td>
	<td align="left">long</td>
	<td align="left">The last time the node reported its health (in ms since epoch)</td></tr>
	<tr class="b">
	<td align="left">usedMemoryMB</td>
	<td align="left">long</td>
	<td align="left">The total about of memory currently used on the node (in MB)</td></tr>
	<tr class="a">
	<td align="left">availMemoryMB</td>
	<td align="left">long</td>
	<td align="left">The total amount of memory currently available on the node (in MB)</td></tr>
	<tr class="b">
	<td align="left">numContainers</td>
	<td align="left">int</td>
	<td align="left">The total number of containers currently running on the node</td></tr></table></div>
	<div class="section">
	<h4>Response Examples<a name="Response_Examples"></a></h4>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/nodes/h2:1235</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/json
	Transfer-Encoding: chunked
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre>{
	"node":
	{
	"rack":"\/default-rack",
	"state":"NEW",
	"id":"h2:1235",
	"nodeHostName":"h2",
	"nodeHTTPAddress":"h2:2",
	"healthStatus":"Healthy",
	"lastHealthUpdate":1324056895432,
	"healthReport":"Healthy",
	"numContainers":0,
	"usedMemoryMB":0,
	"availMemoryMB":5120
	}
	}</pre></div>
	<p><b>JSON response</b></p>
	<p>HTTP Request:</p>
	<div>
	<pre> GET http://<rm http address:port>/ws/v1/cluster/node/h2:1235
	Accept: application/xml</pre></div>
	<p>Response Header:</p>
	<div class="source">
	<pre> HTTP/1.1 200 OK
	Content-Type: application/xml
	Content-Length: 552
	Server: Jetty(6.1.26)</pre></div>
	<p>Response Body:</p>
	<div class="source">
	<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<node>
	<rack>/default-rack</rack>
	<state>NEW</state>
	<id>h2:1235</id>
	<nodeHostName>h2</nodeHostName>
	<nodeHTTPAddress>h2:2</nodeHTTPAddress>
	<healthStatus>Healthy</healthStatus>
	<lastHealthUpdate>1324333268447</lastHealthUpdate>
	<healthReport>Healthy</healthReport>
	<numContainers>0</numContainers>
	<usedMemoryMB>0</usedMemoryMB>
	<availMemoryMB>5120</availMemoryMB>
	</node></pre></div></div></div></div>
	</div>
	</div>
	<div class="clear">
	<hr/>
	</div>
	<div id="footer">
	<div class="xright">© 2014
	Apache Software Foundation

	- <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
	<div class="clear">
	<hr/>
	</div>
	</div>
	</body>
	</html>

ResourceManagerRest.htmlNo OneTemporaryActions

File Metadata

ResourceManagerRest.htmlView Options

Event Timeline

ResourceManagerRest.html
No OneTemporary
Actions

ResourceManagerRest.html
View Options