NodeManagerRest.html
6c2cef95801emaster

NodeManagerRest.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 - NodeManager 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>NodeManager REST API's.<a name="NodeManager_REST_APIs."></a></h2>
			<p>[ <a href="./index.html">Go Back</a> ]</p>
			<ul>
			<li><a href="#NodeManager_REST_APIs.">NodeManager REST API's.</a>
			<ul>
			<li><a href="#Overview">Overview</a></li>
			<li><a href="#NodeManager_Information_API">NodeManager Information API</a></li>
			<li><a href="#Applications_API">Applications API</a></li>
			<li><a href="#Application_API">Application API</a></li>
			<li><a href="#Containers_API">Containers API</a></li>
			<li><a href="#Container_API">Container API</a></li></ul></li></ul>
			<div class="section">
			<h3>Overview<a name="Overview"></a></h3>
			<p>The NodeManager REST API's allow the user to get status on the node and information about applications and containers running on that node. </p></div>
			<div class="section">
			<h3>NodeManager Information API<a name="NodeManager_Information_API"></a></h3>
			<p>The node information resource provides overall information about that particular node.</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://<nm http address:port>/ws/v1/node
			* http://<nm http address:port>/ws/v1/node/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>nodeInfo</i> object<a name="Elements_of_the_nodeInfo_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 NodeManager id</td></tr>
			<tr class="a">
			<td align="left">nodeHostName</td>
			<td align="left">string</td>
			<td align="left">The host name of the NodeManager</td></tr>
			<tr class="b">
			<td align="left">totalPmemAllocatedContainersMB</td>
			<td align="left">long</td>
			<td align="left">The amount of physical memory allocated for use by containers in MB</td></tr>
			<tr class="a">
			<td align="left">totalVmemAllocatedContainersMB</td>
			<td align="left">long</td>
			<td align="left">The amount of virtual memory allocated for use by containers in MB</td></tr>
			<tr class="b">
			<td align="left">lastNodeUpdateTime</td>
			<td align="left">long</td>
			<td align="left">The last timestamp at which the health report was received (in ms since epoch)</td></tr>
			<tr class="a">
			<td align="left">healthReport</td>
			<td align="left">string</td>
			<td align="left">The diagnostic health report of the node</td></tr>
			<tr class="b">
			<td align="left">nodeHealthy</td>
			<td align="left">boolean</td>
			<td align="left">true/false indicator of if the node is healthy</td></tr>
			<tr class="a">
			<td align="left">nodeManagerVersion</td>
			<td align="left">string</td>
			<td align="left">Version of the NodeManager</td></tr>
			<tr class="b">
			<td align="left">nodeManagerBuildVersion</td>
			<td align="left">string</td>
			<td align="left">NodeManager build string with build version, user, and checksum</td></tr>
			<tr class="a">
			<td align="left">nodeManagerVersionBuiltOn</td>
			<td align="left">string</td>
			<td align="left">Timestamp when NodeManager was built(in ms since epoch)</td></tr>
			<tr class="b">
			<td align="left">hadoopVersion</td>
			<td align="left">string</td>
			<td align="left">Version of hadoop common</td></tr>
			<tr class="a">
			<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="b">
			<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://<nm http address:port>/ws/v1/node/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>{
			"nodeInfo" : {
			"hadoopVersionBuiltOn" : "Mon Jan 9 14:58:42 UTC 2012",
			"nodeManagerBuildVersion" : "0.23.1-SNAPSHOT from 1228355 by user1 source checksum 20647f76c36430e888cc7204826a445c",
			"lastNodeUpdateTime" : 1326222266126,
			"totalVmemAllocatedContainersMB" : 17203,
			"nodeHealthy" : true,
			"healthReport" : "",
			"totalPmemAllocatedContainersMB" : 8192,
			"nodeManagerVersionBuiltOn" : "Mon Jan 9 15:01:59 UTC 2012",
			"nodeManagerVersion" : "0.23.1-SNAPSHOT",
			"id" : "host.domain.com:8041",
			"hadoopBuildVersion" : "0.23.1-SNAPSHOT from 1228292 by user1 source checksum 3eba233f2248a089e9b28841a784dd00",
			"nodeHostName" : "host.domain.com",
			"hadoopVersion" : "0.23.1-SNAPSHOT"
			}
			}</pre></div>
			<p><b>XML response</b></p>
			<p>HTTP Request:</p>
			<div>
			<pre> Accept: application/xml
			GET http://<nm http address:port>/ws/v1/node/info</pre></div>
			<p>Response Header:</p>
			<div class="source">
			<pre> HTTP/1.1 200 OK
			Content-Type: application/xml
			Content-Length: 983
			Server: Jetty(6.1.26)</pre></div>
			<p>Response Body:</p>
			<div class="source">
			<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
			<nodeInfo>
			<healthReport/>
			<totalVmemAllocatedContainersMB>17203</totalVmemAllocatedContainersMB>
			<totalPmemAllocatedContainersMB>8192</totalPmemAllocatedContainersMB>
			<lastNodeUpdateTime>1326222386134</lastNodeUpdateTime>
			<nodeHealthy>true</nodeHealthy>
			<nodeManagerVersion>0.23.1-SNAPSHOT</nodeManagerVersion>
			<nodeManagerBuildVersion>0.23.1-SNAPSHOT from 1228355 by user1 source checksum 20647f76c36430e888cc7204826a445c</nodeManagerBuildVersion>
			<nodeManagerVersionBuiltOn>Mon Jan 9 15:01:59 UTC 2012</nodeManagerVersionBuiltOn>
			<hadoopVersion>0.23.1-SNAPSHOT</hadoopVersion>
			<hadoopBuildVersion>0.23.1-SNAPSHOT from 1228292 by user1 source checksum 3eba233f2248a089e9b28841a784dd00</hadoopBuildVersion>
			<hadoopVersionBuiltOn>Mon Jan 9 14:58:42 UTC 2012</hadoopVersionBuiltOn>
			<id>host.domain.com:8041</id>
			<nodeHostName>host.domain.com</nodeHostName>
			</nodeInfo></pre></div></div></div>
			<div class="section">
			<h3>Applications API<a name="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. See also <a href="#Application_API">Application API</a> for syntax of the application object.</p>
			<div class="section">
			<h4>URI<a name="URI"></a></h4>
			<div>
			<pre> * http://<nm http address:port>/ws/v1/node/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 paramters can be specified. </p>
			<div>
			<pre> * state - application state
			* user - user name</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 app objects(XML)</td>
			<td align="left">A 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://<nm http address:port>/ws/v1/node/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" : [
			{
			"containerids" : [
			"container_1326121700862_0003_01_000001",
			"container_1326121700862_0003_01_000002"
			],
			"user" : "user1",
			"id" : "application_1326121700862_0003",
			"state" : "RUNNING"
			},
			{
			"user" : "user1",
			"id" : "application_1326121700862_0002",
			"state" : "FINISHED"
			}
			]
			}
			}</pre></div>
			<p><b>XML response</b></p>
			<p>HTTP Request:</p>
			<div>
			<pre> GET http://<nm http address:port>/ws/v1/node/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: 400
			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_1326121700862_0002</id>
			<state>FINISHED</state>
			<user>user1</user>
			</app>
			<app>
			<id>application_1326121700862_0003</id>
			<state>RUNNING</state>
			<user>user1</user>
			<containerids>container_1326121700862_0003_01_000002</containerids>
			<containerids>container_1326121700862_0003_01_000001</containerids>
			</app>
			</apps>
			</pre></div></div></div>
			<div class="section">
			<h3><a name="Application_API">Application API</a></h3>
			<p>An application resource contains information about a particular application that was run or is running on this NodeManager.</p>
			<div class="section">
			<h4>URI<a name="URI"></a></h4>
			<p>Use the following URI to obtain an app Object, for a application identified by the <a name="appid">appid</a> value. </p>
			<div>
			<pre> * http://<nm http address:port>/ws/v1/node/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>
			<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 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">state</td>
			<td align="left">string</td>
			<td align="left">The state of the application - valid states are: NEW, INITING, RUNNING, FINISHING_CONTAINERS_WAIT, APPLICATION_RESOURCES_CLEANINGUP, FINISHED</td></tr>
			<tr class="a">
			<td align="left">containerids</td>
			<td align="left">array of containerids(JSON)/zero or more containerids(XML)</td>
			<td align="left">The list of containerids currently being used by the application on this node. If not present then no containers are currently running for this application.</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://<nm http address:port>/ws/v1/node/apps/application_1326121700862_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" : {
			"containerids" : [
			"container_1326121700862_0005_01_000003",
			"container_1326121700862_0005_01_000001"
			],
			"user" : "user1",
			"id" : "application_1326121700862_0005",
			"state" : "RUNNING"
			}
			}</pre></div>
			<p><b>XML response</b></p>
			<p>HTTP Request:</p>
			<div>
			<pre> GET http://<nm http address:port>/ws/v1/node/apps/application_1326121700862_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: 281
			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_1326121700862_0005</id>
			<state>RUNNING</state>
			<user>user1</user>
			<containerids>container_1326121700862_0005_01_000003</containerids>
			<containerids>container_1326121700862_0005_01_000001</containerids>
			</app></pre></div></div></div>
			<div class="section">
			<h3>Containers API<a name="Containers_API"></a></h3>
			<p>With the containers API, you can obtain a collection of resources, each of which represents a container. When you run a GET operation on this resource, you obtain a collection of Container Objects. See also <a href="#Container_API">Container API</a> for syntax of the container object.</p>
			<div class="section">
			<h4>URI<a name="URI"></a></h4>
			<div>
			<pre> * http://<nm http address:port>/ws/v1/node/containers</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>containers</i> object<a name="Elements_of_the_containers_object"></a></h4>
			<p>When you make a request for the list of containers, the information will be returned as collection of container objects. See also <a href="#Container_API">Container API</a> for syntax of the container 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">containers</td>
			<td align="left">array of container objects(JSON)/zero or more container objects(XML)</td>
			<td align="left">A collection of container 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://<nm http address:port>/ws/v1/node/containers</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>{
			"containers" : {
			"container" : [
			{
			"nodeId" : "host.domain.com:8041",
			"totalMemoryNeededMB" : 2048,
			"state" : "RUNNING",
			"diagnostics" : "",
			"containerLogsLink" : "http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000001/user1",
			"user" : "user1",
			"id" : "container_1326121700862_0006_01_000001",
			"exitCode" : -1000
			},
			{
			"nodeId" : "host.domain.com:8041",
			"totalMemoryNeededMB" : 2048,
			"state" : "RUNNING",
			"diagnostics" : "",
			"containerLogsLink" : "http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000003/user1",
			"user" : "user1",
			"id" : "container_1326121700862_0006_01_000003",
			"exitCode" : -1000
			}
			]
			}
			}</pre></div>
			<p><b>XML response</b></p>
			<p>HTTP Request:</p>
			<div>
			<pre> GET http://<nm http address:port>/ws/v1/node/containers
			Accept: application/xml</pre></div>
			<p>Response Header:</p>
			<div class="source">
			<pre> HTTP/1.1 200 OK
			Content-Type: application/xml
			Content-Length: 988
			Server: Jetty(6.1.26)</pre></div>
			<p>Response Body:</p>
			<div class="source">
			<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
			<containers>
			<container>
			<id>container_1326121700862_0006_01_000001</id>
			<state>RUNNING</state>
			<exitCode>-1000</exitCode>
			<diagnostics/>
			<user>user1</user>
			<totalMemoryNeededMB>2048</totalMemoryNeededMB>
			<containerLogsLink>http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000001/user1</containerLogsLink>
			<nodeId>host.domain.com:8041</nodeId>
			</container>
			<container>
			<id>container_1326121700862_0006_01_000003</id>
			<state>DONE</state>
			<exitCode>0</exitCode>
			<diagnostics>Container killed by the ApplicationMaster.</diagnostics>
			<user>user1</user>
			<totalMemoryNeededMB>2048</totalMemoryNeededMB>
			<containerLogsLink>http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000003/user1</containerLogsLink>
			<nodeId>host.domain.com:8041</nodeId>
			</container>
			</containers></pre></div></div></div>
			<div class="section">
			<h3><a name="Container_API">Container API</a></h3>
			<p>A container resource contains information about a particular container that is running on this NodeManager.</p>
			<div class="section">
			<h4>URI<a name="URI"></a></h4>
			<p>Use the following URI to obtain a Container Object, from a container identified by the <a name="containerid">containerid</a> value. </p>
			<div>
			<pre> * http://<nm http address:port>/ws/v1/node/containers/{containerid}</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>container</i> object<a name="Elements_of_the_container_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 container id</td></tr>
			<tr class="a">
			<td align="left">state</td>
			<td align="left">string</td>
			<td align="left">State of the container - valid states are: NEW, LOCALIZING, LOCALIZATION_FAILED, LOCALIZED, RUNNING, EXITED_WITH_SUCCESS, EXITED_WITH_FAILURE, KILLING, CONTAINER_CLEANEDUP_AFTER_KILL, CONTAINER_RESOURCES_CLEANINGUP, DONE</td></tr>
			<tr class="b">
			<td align="left">nodeId</td>
			<td align="left">string</td>
			<td align="left">The id of the node the container is on</td></tr>
			<tr class="a">
			<td align="left">containerLogsLink</td>
			<td align="left">string</td>
			<td align="left">The http link to the container logs</td></tr>
			<tr class="b">
			<td align="left">user</td>
			<td align="left">string</td>
			<td align="left">The user name of the user which started the container</td></tr>
			<tr class="a">
			<td align="left">exitCode</td>
			<td align="left">int</td>
			<td align="left">Exit code of the container</td></tr>
			<tr class="b">
			<td align="left">diagnostics</td>
			<td align="left">string</td>
			<td align="left">A diagnostic message for failed containers</td></tr>
			<tr class="a">
			<td align="left">totalMemoryNeededMB</td>
			<td align="left">long</td>
			<td align="left">Total amout of memory needed by the container (in MB)</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://<nm http address:port>/ws/v1/nodes/containers/container_1326121700862_0007_01_000001</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>{
			"container" : {
			"nodeId" : "host.domain.com:8041",
			"totalMemoryNeededMB" : 2048,
			"state" : "RUNNING",
			"diagnostics" : "",
			"containerLogsLink" : "http://host.domain.com:8042/node/containerlogs/container_1326121700862_0007_01_000001/user1",
			"user" : "user1",
			"id" : "container_1326121700862_0007_01_000001",
			"exitCode" : -1000
			}
			}</pre></div>
			<p><b>XML response</b></p>
			<p>HTTP Request:</p>
			<div>
			<pre> GET http://<nm http address:port>/ws/v1/node/containers/container_1326121700862_0007_01_000001
			Accept: application/xml</pre></div>
			<p>Response Header:</p>
			<div class="source">
			<pre> HTTP/1.1 200 OK
			Content-Type: application/xml
			Content-Length: 491
			Server: Jetty(6.1.26)</pre></div>
			<p>Response Body:</p>
			<div class="source">
			<pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
			<container>
			<id>container_1326121700862_0007_01_000001</id>
			<state>RUNNING</state>
			<exitCode>-1000</exitCode>
			<diagnostics/>
			<user>user1</user>
			<totalMemoryNeededMB>2048</totalMemoryNeededMB>
			<containerLogsLink>http://host.domain.com:8042/node/containerlogs/container_1326121700862_0007_01_000001/user1</containerLogsLink>
			<nodeId>host.domain.com:8041</nodeId>
			</container></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>

R3704/2.3.0/hadoop-2.3.0/share/hadoop/hadoop-yarn/hadoop-yarn-site/NodeManagerRest.html6c2cef95801emaster

NodeManagerRest.htmlView Options

R3704/2.3.0/hadoop-2.3.0/share/hadoop/hadoop-yarn/hadoop-yarn-site/NodeManagerRest.html
6c2cef95801emaster

NodeManagerRest.html
View Options