apache
/
hadoop
zrkadlo https://github.com/apache/hadoop.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620
							<!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 2025-06-04
 | Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Apache Hadoop 3.5.0-SNAPSHOT &#x2013; NodeManager REST APIs</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="20250604" />
    <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="xright">            <a href="http://wiki.apache.org/hadoop" class="externalLink">Wiki</a>
            |
                <a href="https://gitbox.apache.org/repos/asf/hadoop.git" class="externalLink">git</a>
            |
                <a href="http://hadoop.apache.org/" class="externalLink">Apache Hadoop</a>
              
                                   &nbsp;| Last Published: 2025-06-04
              &nbsp;| Version: 3.5.0-SNAPSHOT
            </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">Commands Reference</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/FileSystemShell.html">FileSystem Shell</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/Compatibility.html">Compatibility Specification</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/DownstreamDev.html">Downstream Developer's Guide</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/AdminCompatibilityGuide.html">Admin Compatibility Guide</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/InterfaceClassification.html">Interface Classification</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/filesystem/index.html">FileSystem Specification</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/FairCallQueue.html">Fair Call Queue</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">Proxy User</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/RackAwareness.html">Rack Awareness</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>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/CredentialProviderAPI.html">Credential Provider API</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-kms/index.html">Hadoop KMS</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/Tracing.html">Tracing</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/UnixShellGuide.html">Unix Shell Guide</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/registry/index.html">Registry</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/AsyncProfilerServlet.html">Async Profiler</a>
            </li>
          </ul>
                       <h5>HDFS</h5>
                  <ul>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsDesign.html">Architecture</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html">User Guide</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSCommands.html">Commands Reference</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithQJM.html">NameNode HA With QJM</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithNFS.html">NameNode HA With NFS</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/ObserverNameNode.html">Observer NameNode</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/ViewFs.html">ViewFs</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/ViewFsOverloadScheme.html">ViewFsOverloadScheme</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsSnapshots.html">Snapshots</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/LibHdfs.html">libhdfs (C API)</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</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">NFS Gateway</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsRollingUpgrade.html">Rolling Upgrade</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/ExtendedAttributes.html">Extended Attributes</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/TransparentEncryption.html">Transparent Encryption</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsMultihoming.html">Multihoming</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html">Storage Policies</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/MemoryStorage.html">Memory Storage Support</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/SLGUserGuide.html">Synthetic Load Generator</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSErasureCoding.html">Erasure Coding</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSDiskbalancer.html">Disk Balancer</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsUpgradeDomain.html">Upgrade Domain</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsDataNodeAdminGuide.html">DataNode Admin</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs-rbf/HDFSRouterFederation.html">Router Federation</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsProvidedStorage.html">Provided Storage</a>
            </li>
          </ul>
                       <h5>MapReduce</h5>
                  <ul>
                  <li class="none">
                  <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html">Tutorial</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapredCommands.html">Commands Reference</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduce_Compatibility_Hadoop1_Hadoop2.html">Compatibility with 1.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>
                  <li class="none">
                  <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/SharedCacheSupport.html">Support for YARN Shared Cache</a>
            </li>
          </ul>
                       <h5>MapReduce REST APIs</h5>
                  <ul>
                  <li class="none">
                  <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapredAppMasterRest.html">MR Application Master</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-hs/HistoryServerRest.html">MR History Server</a>
            </li>
          </ul>
                       <h5>YARN</h5>
                  <ul>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/YARN.html">Architecture</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/YarnCommands.html">Commands Reference</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/ResourceManagerRestart.html">ResourceManager Restart</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/ResourceManagerHA.html">ResourceManager HA</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/ResourceModel.html">Resource Model</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/NodeLabel.html">Node Labels</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/NodeAttributes.html">Node Attributes</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/TimelineServer.html">Timeline Server</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/TimelineServiceV2.html">Timeline Service V.2</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/YarnApplicationSecurity.html">YARN Application Security</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/NodeManager.html">NodeManager</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/DockerContainers.html">Running Applications in Docker Containers</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/RuncContainers.html">Running Applications in runC Containers</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/NodeManagerCgroups.html">Using CGroups</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/SecureContainer.html">Secure Containers</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/ReservationSystem.html">Reservation System</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/GracefulDecommission.html">Graceful Decommission</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/OpportunisticContainers.html">Opportunistic Containers</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/Federation.html">YARN Federation</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/SharedCache.html">Shared Cache</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/UsingGpus.html">Using GPU</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/UsingFPGA.html">Using FPGA</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/PlacementConstraints.html">Placement Constraints</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/YarnUI2.html">YARN UI2</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/TimelineServer.html#Timeline_Server_REST_API_v1">Timeline Server</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/TimelineServiceV2.html#Timeline_Service_v.2_REST_API">Timeline Service V.2</a>
            </li>
          </ul>
                       <h5>YARN Service</h5>
                  <ul>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/Overview.html">Overview</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/QuickStart.html">QuickStart</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/Concepts.html">Concepts</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/YarnServiceAPI.html">Yarn Service API</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/ServiceDiscovery.html">Service Discovery</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/SystemServices.html">System Services</a>
            </li>
          </ul>
                       <h5>Hadoop Compatible File Systems</h5>
                  <ul>
                  <li class="none">
                  <a href="../../hadoop-aliyun/tools/hadoop-aliyun/index.html">Aliyun OSS</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-aws/tools/hadoop-aws/index.html">Amazon S3</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-azure/index.html">Azure Blob Storage</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-azure-datalake/index.html">Azure Data Lake Storage</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-cos/cloud-storage/index.html">Tencent COS</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-huaweicloud/index.html">Huaweicloud OBS</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-tos/cloud-storage/index.html">VolcanoEngine TOS</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>Tools</h5>
                  <ul>
                  <li class="none">
                  <a href="../../hadoop-streaming/HadoopStreaming.html">Hadoop Streaming</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-archives/HadoopArchives.html">Hadoop Archives</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-archive-logs/HadoopArchiveLogs.html">Hadoop Archive Logs</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-distcp/DistCp.html">DistCp</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-federation-balance/HDFSFederationBalance.html">HDFS Federation Balance</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-gridmix/GridMix.html">GridMix</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-rumen/Rumen.html">Rumen</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-resourceestimator/ResourceEstimator.html">Resource Estimator Service</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-sls/SchedulerLoadSimulator.html">Scheduler Load Simulator</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/Benchmarking.html">Hadoop Benchmarking</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-dynamometer/Dynamometer.html">Dynamometer</a>
            </li>
          </ul>
                       <h5>Reference</h5>
                  <ul>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/release/">Changelog and Release Notes</a>
            </li>
                  <li class="none">
                  <a href="../../api/index.html">Java API docs</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/UnixShellAPI.html">Unix Shell API</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-project-dist/hadoop-common/Metrics.html">Metrics</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-project-dist/hadoop-hdfs-rbf/hdfs-rbf-default.xml">hdfs-rbf-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-kms/kms-default.html">kms-default.xml</a>
            </li>
                  <li class="none">
                  <a href="../../hadoop-hdfs-httpfs/httpfs-default.html">httpfs-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.
-->
<h1>NodeManager REST API&#x2019;s</h1>
<ul>
<li><a href="#Overview">Overview</a></li>
<li><a href="#Enabling_CORS_support">Enabling CORS support</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>
<li><a href="#Auxiliary_Services_API">Auxiliary Services API</a></li>
<li><a href="#Resources_API">Resources API</a></li></ul>
<section>
<h2><a name="Overview"></a>Overview</h2>
<p>The NodeManager REST API&#x2019;s allow the user to get status on the node and information about applications and containers running on that node.</p></section><section>
<h2><a name="Enabling_CORS_support"></a>Enabling CORS support</h2>
<p>To enable cross-origin support (CORS) for the NM only(without enabling it for the RM), please set the following configuration parameters:</p>
<p>In core-site.xml, add org.apache.hadoop.security.HttpCrossOriginFilterInitializer to hadoop.http.filter.initializers. In yarn-site.xml, set yarn.nodemanager.webapp.cross-origin.enabled to true.</p></section><section>
<h2><a name="NodeManager_Information_API"></a>NodeManager Information API</h2>
<p>The node information resource provides overall information about that particular node.</p><section>
<h3><a name="URI"></a>URI</h3>
<p>Both of the following URI&#x2019;s give you the cluster information.</p>
<ul>

<li><a class="externalLink" href="http://nm-http-address:port/ws/v1/node">http://nm-http-address:port/ws/v1/node</a>
<ul>

<li><a class="externalLink" href="http://nm-http-address:port/ws/v1/node/info">http://nm-http-address:port/ws/v1/node/info</a></li>
</ul>
</li>
</ul></section><section>
<h3><a name="HTTP_Operations_Supported"></a>HTTP Operations Supported</h3>
<ul>

<li>GET</li>
</ul></section><section>
<h3><a name="Query_Parameters_Supported"></a>Query Parameters Supported</h3>

<div class="source">
<div class="source">
<pre>  None
</pre></div></div>
</section><section>
<h3><a name="Elements_of_the_nodeInfo_object"></a>Elements of the <i>nodeInfo</i> object</h3>
<table border="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<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"> totalVCoresAllocatedContainers </td>
<td align="left"> long </td>
<td align="left"> The number of virtual cores allocated for use by containers </td></tr>
<tr class="a">
<td align="left"> vmemCheckEnabled </td>
<td align="left"> boolean </td>
<td align="left"> Whether virtual memory checking is enabled for preemption </td></tr>
<tr class="b">
<td align="left"> pmemCheckEnabled </td>
<td align="left"> boolean </td>
<td align="left"> Whether physical memory checking is enabled for preemption </td></tr>
<tr class="a">
<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="b">
<td align="left"> nmStartupTime </td>
<td align="left"> long </td>
<td align="left"> The timestamp at which the node was started (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>
</tbody>
</table></section><section>
<h3><a name="Response_Examples"></a>Response Examples</h3>
<p><b>JSON response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/info
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/json
  Transfer-Encoding: chunked
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>{
  &quot;nodeInfo&quot;: {
    &quot;healthReport&quot;: &quot;&quot;,
    &quot;totalVmemAllocatedContainersMB&quot;: 17203,
    &quot;totalPmemAllocatedContainersMB&quot;: 8192,
    &quot;totalVCoresAllocatedContainers&quot;: 8,
    &quot;vmemCheckEnabled&quot;: false,
    &quot;pmemCheckEnabled&quot;: true,
    &quot;lastNodeUpdateTime&quot;: 1485814574224,
    &quot;nodeHealthy&quot;: true,
    &quot;nodeManagerVersion&quot;: &quot;3.0.0&quot;,
    &quot;nodeManagerBuildVersion&quot;: &quot;3.0.0&quot;,
    &quot;nodeManagerVersionBuiltOn&quot;: &quot;2017-01-30T17:42Z&quot;,
    &quot;hadoopVersion&quot;: &quot;3.0.0&quot;,
    &quot;hadoopBuildVersion&quot;: &quot;3.0.0&quot;,
    &quot;hadoopVersionBuiltOn&quot;: &quot;2017-01-30T17:39Z&quot;,
    &quot;id&quot;: &quot;host.domain.com:46077&quot;,
    &quot;nodeHostName&quot;: &quot;host.domain.com&quot;,
    &quot;nmStartupTime&quot;: 1485800887841
  }
}

</pre></div></div>

<p><b>XML response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  Accept: application/xml
  GET http://nm-http-address:port/ws/v1/node/info
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/xml
  Content-Length: 983
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;
&lt;nodeInfo&gt;
    &lt;healthReport&gt;&lt;/healthReport&gt;
    &lt;totalVmemAllocatedContainersMB&gt;17203&lt;/totalVmemAllocatedContainersMB&gt;
    &lt;totalPmemAllocatedContainersMB&gt;8192&lt;/totalPmemAllocatedContainersMB&gt;
    &lt;totalVCoresAllocatedContainers&gt;8&lt;/totalVCoresAllocatedContainers&gt;
    &lt;vmemCheckEnabled&gt;false&lt;/vmemCheckEnabled&gt;
    &lt;pmemCheckEnabled&gt;true&lt;/pmemCheckEnabled&gt;
    &lt;lastNodeUpdateTime&gt;1485815774203&lt;/lastNodeUpdateTime&gt;
    &lt;nodeHealthy&gt;true&lt;/nodeHealthy&gt;
    &lt;nodeManagerVersion&gt;3.0.0&lt;/nodeManagerVersion&gt;
    &lt;nodeManagerBuildVersion&gt;3.0.0&lt;/nodeManagerBuildVersion&gt;
    &lt;nodeManagerVersionBuiltOn&gt;2017-01-30T17:42Z&lt;/nodeManagerVersionBuiltOn&gt;
    &lt;hadoopVersion&gt;3.0.0&lt;/hadoopVersion&gt;
    &lt;hadoopBuildVersion&gt;3.0.0&lt;/hadoopBuildVersion&gt;
    &lt;hadoopVersionBuiltOn&gt;2017-01-30T17:39Z&lt;/hadoopVersionBuiltOn&gt;
    &lt;id&gt;host.domain.com:46077&lt;/id&gt;
    &lt;nodeHostName&gt;host.domain.com&lt;/nodeHostName&gt;
    &lt;nmStartupTime&gt;1485800887841&lt;/nmStartupTime&gt;
&lt;/nodeInfo&gt;
</pre></div></div>
</section></section><section>
<h2><a name="Applications_API"></a>Applications API</h2>
<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><section>
<h3><a name="URI"></a>URI</h3>
<ul>

<li><a class="externalLink" href="http://nm-http-address:port/ws/v1/node/apps">http://nm-http-address:port/ws/v1/node/apps</a></li>
</ul></section><section>
<h3><a name="HTTP_Operations_Supported"></a>HTTP Operations Supported</h3>
<ul>

<li>GET</li>
</ul></section><section>
<h3><a name="Query_Parameters_Supported"></a>Query Parameters Supported</h3>
<p>Multiple parameters can be specified.</p>
<ul>

<li>state - application state
<ul>

<li>user - user name</li>
</ul>
</li>
</ul></section><section>
<h3><a name="Elements_of_the_apps_.28Applications.29_object"></a>Elements of the <i>apps</i> (Applications) object</h3>
<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="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<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>
</tbody>
</table></section><section>
<h3><a name="Response_Examples"></a>Response Examples</h3>
<p><b>JSON response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/apps
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/json
  Transfer-Encoding: chunked
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>{
   &quot;apps&quot; : {
      &quot;app&quot; : [
         {
            &quot;containerids&quot; : [
               &quot;container_1326121700862_0003_01_000001&quot;,
               &quot;container_1326121700862_0003_01_000002&quot;
            ],
            &quot;user&quot; : &quot;user1&quot;,
            &quot;id&quot; : &quot;application_1326121700862_0003&quot;,
            &quot;state&quot; : &quot;RUNNING&quot;
         },
         {
            &quot;user&quot; : &quot;user1&quot;,
            &quot;id&quot; : &quot;application_1326121700862_0002&quot;,
            &quot;state&quot; : &quot;FINISHED&quot;
         }
      ]
   }
}
</pre></div></div>

<p><b>XML response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/apps
  Accept: application/xml
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/xml
  Content-Length: 400
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;
&lt;apps&gt;
  &lt;app&gt;
    &lt;id&gt;application_1326121700862_0002&lt;/id&gt;
    &lt;state&gt;FINISHED&lt;/state&gt;
    &lt;user&gt;user1&lt;/user&gt;
  &lt;/app&gt;
  &lt;app&gt;
    &lt;id&gt;application_1326121700862_0003&lt;/id&gt;
    &lt;state&gt;RUNNING&lt;/state&gt;
    &lt;user&gt;user1&lt;/user&gt;
    &lt;containerids&gt;container_1326121700862_0003_01_000002&lt;/containerids&gt;
    &lt;containerids&gt;container_1326121700862_0003_01_000001&lt;/containerids&gt;
  &lt;/app&gt;
&lt;/apps&gt;
</pre></div></div>
</section></section><section>
<h2><a name="Application_API"></a>Application API</h2>
<p>An application resource contains information about a particular application that was run or is running on this NodeManager.</p><section>
<h3><a name="URI"></a>URI</h3>
<p>Use the following URI to obtain an app Object, for a application identified by the appid value.</p>
<ul>

<li><a class="externalLink" href="http://nm-http-address:port/ws/v1/node/apps/{appid}">http://nm-http-address:port/ws/v1/node/apps/{appid}</a></li>
</ul></section><section>
<h3><a name="HTTP_Operations_Supported"></a>HTTP Operations Supported</h3>
<ul>

<li>GET</li>
</ul></section><section>
<h3><a name="Query_Parameters_Supported"></a>Query Parameters Supported</h3>

<div class="source">
<div class="source">
<pre>  None
</pre></div></div>
</section><section>
<h3><a name="Elements_of_the_app_.28Application.29_object"></a>Elements of the <i>app</i> (Application) object</h3>
<table border="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<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>
</tbody>
</table></section><section>
<h3><a name="Response_Examples"></a>Response Examples</h3>
<p><b>JSON response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/apps/application_1326121700862_0005
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/json
  Transfer-Encoding: chunked
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>{
   &quot;app&quot; : {
      &quot;containerids&quot; : [
         &quot;container_1326121700862_0005_01_000003&quot;,
         &quot;container_1326121700862_0005_01_000001&quot;
      ],
      &quot;user&quot; : &quot;user1&quot;,
      &quot;id&quot; : &quot;application_1326121700862_0005&quot;,
      &quot;state&quot; : &quot;RUNNING&quot;
   }
}
</pre></div></div>

<p><b>XML response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/apps/application_1326121700862_0005
  Accept: application/xml
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/xml
  Content-Length: 281
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;
&lt;app&gt;
  &lt;id&gt;application_1326121700862_0005&lt;/id&gt;
  &lt;state&gt;RUNNING&lt;/state&gt;
  &lt;user&gt;user1&lt;/user&gt;
  &lt;containerids&gt;container_1326121700862_0005_01_000003&lt;/containerids&gt;
  &lt;containerids&gt;container_1326121700862_0005_01_000001&lt;/containerids&gt;
&lt;/app&gt;
</pre></div></div>
</section></section><section>
<h2><a name="Containers_API"></a>Containers API</h2>
<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><section>
<h3><a name="URI"></a>URI</h3>
<ul>

<li><a class="externalLink" href="http://nm-http-address:port/ws/v1/node/containers">http://nm-http-address:port/ws/v1/node/containers</a></li>
</ul></section><section>
<h3><a name="HTTP_Operations_Supported"></a>HTTP Operations Supported</h3>
<ul>

<li>GET</li>
</ul></section><section>
<h3><a name="Query_Parameters_Supported"></a>Query Parameters Supported</h3>

<div class="source">
<div class="source">
<pre>  None
</pre></div></div>
</section><section>
<h3><a name="Elements_of_the_containers_object"></a>Elements of the <i>containers</i> object</h3>
<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="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<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>
</tbody>
</table></section><section>
<h3><a name="Response_Examples"></a>Response Examples</h3>
<p><b>JSON response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/containers
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/json
  Transfer-Encoding: chunked
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>{
   &quot;containers&quot; : {
      &quot;container&quot; : [
         {
            &quot;nodeId&quot; : &quot;host.domain.com:8041&quot;,
            &quot;totalMemoryNeededMB&quot; : 2048,
            &quot;totalVCoresNeeded&quot; : 1,
            &quot;state&quot; : &quot;RUNNING&quot;,
            &quot;diagnostics&quot; : &quot;&quot;,
            &quot;containerLogsLink&quot; : &quot;http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000001/user1&quot;,
            &quot;user&quot; : &quot;user1&quot;,
            &quot;id&quot; : &quot;container_1326121700862_0006_01_000001&quot;,
            &quot;exitCode&quot; : -1000,
            &quot;executionType&quot;: &quot;GUARANTEED&quot;,
            &quot;containerLogFiles&quot;: [
              &quot;stdout&quot;,
              &quot;stderr&quot;,
              &quot;syslog&quot;
            ]
         },
         {
            &quot;nodeId&quot; : &quot;host.domain.com:8041&quot;,
            &quot;totalMemoryNeededMB&quot; : 2048,
            &quot;totalVCoresNeeded&quot; : 2,
            &quot;state&quot; : &quot;RUNNING&quot;,
            &quot;diagnostics&quot; : &quot;&quot;,
            &quot;containerLogsLink&quot; : &quot;http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000003/user1&quot;,
            &quot;user&quot; : &quot;user1&quot;,
            &quot;id&quot; : &quot;container_1326121700862_0006_01_000003&quot;,
            &quot;exitCode&quot; : -1000,
            &quot;executionType&quot;: &quot;GUARANTEED&quot;,
            &quot;containerLogFiles&quot;: [
              &quot;stdout&quot;,
              &quot;stderr&quot;,
              &quot;syslog&quot;
            ]
         }
      ]
   }
}
</pre></div></div>

<p><b>XML response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/containers
  Accept: application/xml
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/xml
  Content-Length: 988
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;
&lt;containers&gt;
  &lt;container&gt;
    &lt;id&gt;container_1326121700862_0006_01_000001&lt;/id&gt;
    &lt;state&gt;RUNNING&lt;/state&gt;
    &lt;exitCode&gt;-1000&lt;/exitCode&gt;
    &lt;diagnostics/&gt;
    &lt;user&gt;user1&lt;/user&gt;
    &lt;totalMemoryNeededMB&gt;2048&lt;/totalMemoryNeededMB&gt;
    &lt;totalVCoresNeeded&gt;1&lt;/totalVCoresNeeded&gt;
    &lt;containerLogsLink&gt;http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000001/user1&lt;/containerLogsLink&gt;
    &lt;nodeId&gt;host.domain.com:8041&lt;/nodeId&gt;
    &lt;executionType&gt;GUARANTEED&lt;/executionType&gt;
    &lt;containerLogFiles&gt;stdout&lt;/containerLogFiles&gt;
    &lt;containerLogFiles&gt;stderr&lt;/containerLogFiles&gt;
    &lt;containerLogFiles&gt;syslog&lt;/containerLogFiles&gt;
  &lt;/container&gt;
  &lt;container&gt;
    &lt;id&gt;container_1326121700862_0006_01_000003&lt;/id&gt;
    &lt;state&gt;DONE&lt;/state&gt;
    &lt;exitCode&gt;0&lt;/exitCode&gt;
    &lt;diagnostics&gt;Container killed by the ApplicationMaster.&lt;/diagnostics&gt;
    &lt;user&gt;user1&lt;/user&gt;
    &lt;totalMemoryNeededMB&gt;2048&lt;/totalMemoryNeededMB&gt;
    &lt;totalVCoresNeeded&gt;2&lt;/totalVCoresNeeded&gt;
    &lt;containerLogsLink&gt;http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000003/user1&lt;/containerLogsLink&gt;
    &lt;nodeId&gt;host.domain.com:8041&lt;/nodeId&gt;
    &lt;executionType&gt;GUARANTEED&lt;/executionType&gt;
    &lt;containerLogFiles&gt;stdout&lt;/containerLogFiles&gt;
    &lt;containerLogFiles&gt;stderr&lt;/containerLogFiles&gt;
    &lt;containerLogFiles&gt;syslog&lt;/containerLogFiles&gt;
  &lt;/container&gt;
&lt;/containers&gt;
</pre></div></div>
</section></section><section>
<h2><a name="Container_API"></a>Container API</h2>
<p>A container resource contains information about a particular container that is running on this NodeManager.</p><section>
<h3><a name="URI"></a>URI</h3>
<p>Use the following URI to obtain a Container Object, from a container identified by the containerid value.</p>
<ul>

<li><a class="externalLink" href="http://nm-http-address:port/ws/v1/node/containers/{containerid}">http://nm-http-address:port/ws/v1/node/containers/{containerid}</a></li>
</ul></section><section>
<h3><a name="HTTP_Operations_Supported"></a>HTTP Operations Supported</h3>
<ul>

<li>GET</li>
</ul></section><section>
<h3><a name="Query_Parameters_Supported"></a>Query Parameters Supported</h3>

<div class="source">
<div class="source">
<pre>  None
</pre></div></div>
</section><section>
<h3><a name="Elements_of_the_container_object"></a>Elements of the <i>container</i> object</h3>
<table border="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<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>
<tr class="b">
<td align="left"> totalVCoresNeeded </td>
<td align="left"> long </td>
<td align="left"> Total number of virtual cores needed by the container </td></tr>
<tr class="a">
<td align="left"> executionType </td>
<td align="left"> string </td>
<td align="left"> Container type of GUARANTEED or OPPORTUNISTIC </td></tr>
<tr class="b">
<td align="left"> containerLogFiles </td>
<td align="left"> array of strings </td>
<td align="left"> Container log file names </td></tr>
</tbody>
</table></section><section>
<h3><a name="Response_Examples"></a>Response Examples</h3>
<p><b>JSON response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/containers/container_1326121700862_0007_01_000001
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/json
  Transfer-Encoding: chunked
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>{
   &quot;container&quot; : {
      &quot;nodeId&quot; : &quot;host.domain.com:8041&quot;,
      &quot;totalMemoryNeededMB&quot; : 2048,
      &quot;totalVCoresNeeded&quot; : 1,
      &quot;state&quot; : &quot;RUNNING&quot;,
      &quot;diagnostics&quot; : &quot;&quot;,
      &quot;containerLogsLink&quot; : &quot;http://host.domain.com:8042/node/containerlogs/container_1326121700862_0007_01_000001/user1&quot;,
      &quot;user&quot; : &quot;user1&quot;,
      &quot;id&quot; : &quot;container_1326121700862_0007_01_000001&quot;,
      &quot;exitCode&quot; : -1000,
      &quot;executionType&quot;: &quot;GUARANTEED&quot;,
      &quot;containerLogFiles&quot;: [
        &quot;stdout&quot;,
        &quot;stderr&quot;,
        &quot;syslog&quot;
      ]
   }
}
</pre></div></div>

<p><b>XML response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/containers/container_1326121700862_0007_01_000001
  Accept: application/xml
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/xml
  Content-Length: 491
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;
&lt;container&gt;
  &lt;id&gt;container_1326121700862_0007_01_000001&lt;/id&gt;
  &lt;state&gt;RUNNING&lt;/state&gt;
  &lt;exitCode&gt;-1000&lt;/exitCode&gt;
  &lt;diagnostics/&gt;
  &lt;user&gt;user1&lt;/user&gt;
  &lt;totalMemoryNeededMB&gt;2048&lt;/totalMemoryNeededMB&gt;
  &lt;totalVCoresNeeded&gt;1&lt;/totalVCoresNeeded&gt;
  &lt;containerLogsLink&gt;http://host.domain.com:8042/node/containerlogs/container_1326121700862_0007_01_000001/user1&lt;/containerLogsLink&gt;
  &lt;nodeId&gt;host.domain.com:8041&lt;/nodeId&gt;
  &lt;executionType&gt;GUARANTEED&lt;/executionType&gt;
  &lt;containerLogFiles&gt;stdout&lt;/containerLogFiles&gt;
  &lt;containerLogFiles&gt;stderr&lt;/containerLogFiles&gt;
  &lt;containerLogFiles&gt;syslog&lt;/containerLogFiles&gt;
&lt;/container&gt;
</pre></div></div>
</section></section><section>
<h2><a name="Auxiliary_Services_API"></a>Auxiliary Services API</h2>
<p>With the auxiliary services API, you can obtain a collection of resources, each of which represents an auxiliary service. When you run a GET operation on this resource, you obtain a collection of auxiliary service information objects.</p>
<p>A YARN admin can use a PUT operation to update the auxiliary services running on the NodeManager. The body of the request should be of the same format as an auxiliary services manifest file.</p><section>
<h3><a name="URI"></a>URI</h3>
<ul>

<li><a class="externalLink" href="http://nm-http-address:port/ws/v1/node/auxiliaryservices">http://nm-http-address:port/ws/v1/node/auxiliaryservices</a></li>
</ul></section><section>
<h3><a name="HTTP_Operations_Supported"></a>HTTP Operations Supported</h3>
<ul>

<li>GET</li>
<li>PUT</li>
</ul></section><section>
<h3><a name="Query_Parameters_Supported"></a>Query Parameters Supported</h3>

<div class="source">
<div class="source">
<pre>  None
</pre></div></div>
</section><section>
<h3><a name="Elements_of_the_auxiliaryservices_object"></a>Elements of the <i>auxiliaryservices</i> object</h3>
<p>When you make a request for the list of auxiliary services, the information will be returned as collection of service information objects.</p>
<table border="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<tr class="b">
<td align="left"> services </td>
<td align="left"> array of service information objects(JSON)/zero or more service information objects (XML) </td>
<td align="left"> A collection of service information objects </td></tr>
</tbody>
</table></section><section>
<h3><a name="GET_Response_Examples"></a>GET Response Examples</h3>
<p><b>JSON response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/auxiliaryservices
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/json
  Transfer-Encoding: chunked
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>{
    &quot;services&quot;: {
        &quot;service&quot;: [
            {
                &quot;name&quot;: &quot;timeline_collector&quot;,
                &quot;startTime&quot;: &quot;2018-12-18 21:24:27&quot;,
                &quot;version&quot;: &quot;1&quot;
            },
            {
                &quot;name&quot;: &quot;mapreduce_shuffle&quot;,
                &quot;startTime&quot;: &quot;2018-12-18 21:24:27&quot;,
                &quot;version&quot;: &quot;2&quot;
            }
        ]
    }
}
</pre></div></div>

<p><b>XML response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/auxiliaryservices
  Accept: application/xml
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  HTTP/1.1 200 OK
  Content-Type: application/xml
  Content-Length: 299
  Server: Jetty(6.1.26)
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;
&lt;services&gt;
  &lt;service&gt;
    &lt;name&gt;timeline_collector&lt;/name&gt;
    &lt;version&gt;1&lt;/version&gt;
    &lt;startTime&gt;2018-12-18 21:00:00&lt;/startTime&gt;
  &lt;/service&gt;
  &lt;service&gt;
    &lt;name&gt;mapreduce_shuffle&lt;/name&gt;
    &lt;version&gt;2&lt;/version&gt;
    &lt;startTime&gt;2018-12-18 21:00:00&lt;/startTime&gt;
  &lt;/service&gt;
&lt;/services&gt;
</pre></div></div>
</section></section><section>
<h2><a name="Resources_API"></a>Resources API</h2>
<p>With Resources API, you can list the GPU resources present on the NodeManager.</p><section>
<h3><a name="URI"></a>URI</h3>
<p>Use the following URI to obtain resources on the NodeManager</p>
<ul>

<li><a class="externalLink" href="http://nm-http-address:port/ws/v1/node/resources/{resourcename}">http://nm-http-address:port/ws/v1/node/resources/{resourcename}</a></li>
</ul></section><section>
<h3><a name="HTTP_Operations_Supported"></a>HTTP Operations Supported</h3>
<ul>

<li>GET</li>
</ul></section><section>
<h3><a name="Query_Parameters_Supported"></a>Query Parameters Supported</h3>

<div class="source">
<div class="source">
<pre>  None
</pre></div></div>
</section><section>
<h3><a name="Elements_of_the_NMGpuResourceInfo_object"></a>Elements of the <i>NMGpuResourceInfo</i> object</h3>
<p>The response to this request if any GPU device is present on the NodeManager.</p>
<table border="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<tr class="b">
<td align="left"> gpuDeviceInformation </td>
<td align="left"> GpuDeviceInformation </td>
<td align="left"> Contains all GPU Device Information in the system </td></tr>
<tr class="a">
<td align="left"> totalGpuDevices </td>
<td align="left"> List of GpuDevice objects </td>
<td align="left"> Contains the representations of GPU devices </td></tr>
<tr class="b">
<td align="left"> assignedGpuDevices </td>
<td align="left"> List of AssignedGpuDevice objects </td>
<td align="left"> In addition to GpuDevice, AssignedGpuDevice includes container ID </td></tr>
</tbody>
</table></section><section>
<h3><a name="Elements_of_the_GpuDeviceInformation_object"></a>Elements of the <i>GpuDeviceInformation</i> object</h3>
<table border="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<tr class="b">
<td align="left"> gpus </td>
<td align="left"> List of PerGpuDeviceInformation objects </td>
<td align="left"> Information objects about specific GPU devices </td></tr>
<tr class="a">
<td align="left"> driverVersion </td>
<td align="left"> String </td>
<td align="left"> &#x2026; </td></tr>
</tbody>
</table></section><section>
<h3><a name="Elements_of_the_PerGpuDeviceInformation_object"></a>Elements of the <i>PerGpuDeviceInformation</i> object</h3>
<table border="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<tr class="b">
<td align="left"> productName </td>
<td align="left"> String </td>
<td align="left"> Name of the GPU device </td></tr>
<tr class="a">
<td align="left"> uuid </td>
<td align="left"> String </td>
<td align="left"> Universally unique identifier of the GPU device </td></tr>
<tr class="b">
<td align="left"> minorNumber </td>
<td align="left"> int </td>
<td align="left"> Secondary identifier of the GPU device </td></tr>
</tbody>
</table></section><section>
<h3><a name="Elements_of_the_GpuDevice_object"></a>Elements of the <i>GpuDevice</i> object</h3>
<table border="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<tr class="b">
<td align="left"> index </td>
<td align="left"> int </td>
<td align="left"> Main identifier of the GPU device </td></tr>
<tr class="a">
<td align="left"> minorNumber </td>
<td align="left"> int </td>
<td align="left"> Secondary identifier of the GPU device </td></tr>
</tbody>
</table></section><section>
<h3><a name="Elements_of_the_AssignedGpuDevice_object"></a>Elements of the <i>AssignedGpuDevice</i> object</h3>
<table border="0" class="bodyTable">
<thead>

<tr class="a">
<th align="left"> Properties </th>
<th align="left"> Data Type </th>
<th align="left"> Description </th></tr>
</thead><tbody>

<tr class="b">
<td align="left"> index </td>
<td align="left"> int </td>
<td align="left"> Main identifier of the GPU device </td></tr>
<tr class="a">
<td align="left"> minorNumber </td>
<td align="left"> int </td>
<td align="left"> Secondary identifier of the GPU device </td></tr>
<tr class="b">
<td align="left"> containerId </td>
<td align="left"> String </td>
<td align="left"> Identifier of the container </td></tr>
</tbody>
</table></section><section>
<h3><a name="GET_Response_Examples"></a>GET Response Examples</h3>
<p><b>JSON response</b></p>
<p>HTTP Request:</p>

<div class="source">
<div class="source">
<pre>  GET http://nm-http-address:port/ws/v1/node/resources/yarn.io%2Fgpu
</pre></div></div>

<p>Response Header:</p>

<div class="source">
<div class="source">
<pre>  Cache-Control: no-cache
  Pragma: no-cache
  X-Content-Type-Options: nosniff
  X-XSS-Protection: 1; mode=block
  X-Frame-Options: SAMEORIGIN
  Content-Type: application/json;charset=utf-8
  Vary: Accept-Encoding
  Content-Encoding: gzip
  Transfer-Encoding: chunked
</pre></div></div>

<p>Response Body:</p>

<div class="source">
<div class="source">
<pre>{
    &quot;gpuDeviceInformation&quot;: null,
    &quot;totalGpuDevices&quot;: [
        {
            &quot;index&quot;: 0,
            &quot;minorNumber&quot;: 0
        },
        {
            &quot;index&quot;: 1,
            &quot;minorNumber&quot;: 1
        },
        {
            &quot;index&quot;: 2,
            &quot;minorNumber&quot;: 2
        },
        {
            &quot;index&quot;: 3,
            &quot;minorNumber&quot;: 4
        }
    ],
    &quot;assignedGpuDevices&quot;: []
}
</pre></div></div></section></section>
      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">
        &#169;            2008-2025
              Apache Software Foundation
            
                          - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
        Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
      </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>