big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

YARN-5757. RM REST API documentation is not up to date (Miklos Szegedi via Varun Saxena)

Browse Source
This commit is contained in:
Varun Saxena 2016-10-27 17:21:01 +05:30
parent 6c8830992c
commit 8bd6d77a41
3 changed files with 371 additions and 242 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-hs/src/site/markdown/HistoryServerRest.md
View File

@ -140,7 +140,7 @@ The jobs resource provides a list of the MapReduce jobs that have finished. It d
#### Query Parameters Supported #### Query Parameters Supported
Multiple paramters can be specified. The started and finished times have a begin and end parameter to allow you to specify ranges. For example, one could request all jobs that started between 1:00am and 2:00pm on 12/19/2011 with startedTimeBegin=1324256400&startedTimeEnd=1324303200. If the Begin parameter is not specfied, it defaults to 0, and if the End parameter is not specified, it defaults to infinity. Multiple parameters can be specified. The started and finished times have a begin and end parameter to allow you to specify ranges. For example, one could request all jobs that started between 1:00am and 2:00pm on 12/19/2011 with startedTimeBegin=1324256400&startedTimeEnd=1324303200. If the Begin parameter is not specfied, it defaults to 0, and if the End parameter is not specified, it defaults to infinity.
* user - user name * user - user name
* state - the job state * state - the job state

2
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/NodeManagerRest.md
View File

@ -163,7 +163,7 @@ With the Applications API, you can obtain a collection of resources, each of whi
### Query Parameters Supported ### Query Parameters Supported
Multiple paramters can be specified. Multiple parameters can be specified.
* state - application state * state - application state
* user - user name * user - user name

495
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/ResourceManagerRest.md
View File

@ -79,12 +79,14 @@ Both of the following URI's give you the cluster information.
| startedOn | long | The time the cluster started (in ms since epoch) | | startedOn | long | The time the cluster started (in ms since epoch) |
| state | string | The ResourceManager state - valid values are: NOTINITED, INITED, STARTED, STOPPED | | state | string | The ResourceManager state - valid values are: NOTINITED, INITED, STARTED, STOPPED |
| haState | string | The ResourceManager HA state - valid values are: INITIALIZING, ACTIVE, STANDBY, STOPPED | | haState | string | The ResourceManager HA state - valid values are: INITIALIZING, ACTIVE, STANDBY, STOPPED |
| rmStateStoreName | string | Fully qualified name of class that implements the storage of ResourceManager state |
| resourceManagerVersion | string | Version of the ResourceManager | | resourceManagerVersion | string | Version of the ResourceManager |
| resourceManagerBuildVersion | string | ResourceManager build string with build version, user, and checksum | | resourceManagerBuildVersion | string | ResourceManager build string with build version, user, and checksum |
| resourceManagerVersionBuiltOn | string | Timestamp when ResourceManager was built (in ms since epoch) | | resourceManagerVersionBuiltOn | string | Timestamp when ResourceManager was built (in ms since epoch) |
| hadoopVersion | string | Version of hadoop common | | hadoopVersion | string | Version of hadoop common |
| hadoopBuildVersion | string | Hadoop common build string with build version, user, and checksum | | hadoopBuildVersion | string | Hadoop common build string with build version, user, and checksum |
| hadoopVersionBuiltOn | string | Timestamp when hadoop common was built(in ms since epoch) | | hadoopVersionBuiltOn | string | Timestamp when hadoop common was built(in ms since epoch) |
| haZooKeeperConnectionState | string | State of ZooKeeper connection of the high availability service |
### Response Examples ### Response Examples
@ -110,13 +112,15 @@ Response Body:
"id":1324053971963, "id":1324053971963,
"startedOn":1324053971963, "startedOn":1324053971963,
"state":"STARTED", "state":"STARTED",
"resourceManagerVersion":"0.23.1-SNAPSHOT", "haState":"ACTIVE",
"resourceManagerBuildVersion":"0.23.1-SNAPSHOT from 1214049 by user1 source checksum 050cd664439d931c8743a6428fd6a693", "rmStateStoreName":"org.apache.hadoop.yarn.server.resourcemanager.recovery.NullRMStateStore",
"resourceManagerVersionBuiltOn":"Tue Dec 13 22:12:48 CST 2011", "resourceManagerVersion":"3.0.0-SNAPSHOT",
"hadoopVersion":"0.23.1-SNAPSHOT", "resourceManagerBuildVersion":"3.0.0-SNAPSHOT from unknown by user1 source checksum 11111111111111111111111111111111",
"hadoopBuildVersion":"0.23.1-SNAPSHOT from 1214049 by user1 source checksum 11458df3bb77342dca5f917198fad328", "resourceManagerVersionBuiltOn":"2016-01-01T01:00Z",
"hadoopVersionBuiltOn":"Tue Dec 13 22:12:26 CST 2011" "hadoopVersion":"3.0.0-SNAPSHOT",
} "hadoopBuildVersion":"3.0.0-SNAPSHOT from unknown by user1 source checksum 11111111111111111111111111111111",
"hadoopVersionBuiltOn":"2016-01-01T01:00Z",
"haZooKeeperConnectionState": "ResourceManager HA is not enabled." }
} }
``` ```
@ -139,15 +143,18 @@ Response Body:
```xml ```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<clusterInfo> <clusterInfo>
<id>1324053971963</id> <id>1476912658570</id>
<startedOn>1324053971963</startedOn> <startedOn>1476912658570</startedOn>
<state>STARTED</state> <state>STARTED</state>
<resourceManagerVersion>0.23.1-SNAPSHOT</resourceManagerVersion> <haState>ACTIVE</haState>
<resourceManagerBuildVersion>0.23.1-SNAPSHOT from 1214049 by user1 source checksum 050cd664439d931c8743a6428fd6a693</resourceManagerBuildVersion> <rmStateStoreName>org.apache.hadoop.yarn.server.resourcemanager.recovery.NullRMStateStore</rmStateStoreName>
<resourceManagerVersionBuiltOn>Tue Dec 13 22:12:48 CST 2011</resourceManagerVersionBuiltOn> <resourceManagerVersion>3.0.0-SNAPSHOT</resourceManagerVersion>
<hadoopVersion>0.23.1-SNAPSHOT</hadoopVersion> <resourceManagerBuildVersion>3.0.0-SNAPSHOT from unknown by user1 source checksum 11111111111111111111111111111111</resourceManagerBuildVersion>
<hadoopBuildVersion>0.23.1-SNAPSHOT from 1214049 by user1 source checksum 11458df3bb77342dca5f917198fad328</hadoopBuildVersion> <resourceManagerVersionBuiltOn>2016-01-01T01:00Z</resourceManagerVersionBuiltOn>
<hadoopVersionBuiltOn>Tue Dec 13 22:12:48 CST 2011</hadoopVersionBuiltOn> <hadoopVersion>3.0.0-SNAPSHOT</hadoopVersion>
<hadoopBuildVersion>3.0.0-SNAPSHOT from unknown by user1 source checksum 11111111111111111111111111111111</hadoopBuildVersion>
<hadoopVersionBuiltOn>2016-01-01T01:00Z</hadoopVersionBuiltOn>
<haZooKeeperConnectionState>ResourceManager HA is not enabled.</haZooKeeperConnectionState>
</clusterInfo> </clusterInfo>
``` ```
@ -193,8 +200,10 @@ The cluster metrics resource provides some overall metrics about the cluster. Mo
| activeNodes | int | The number of active nodes | | activeNodes | int | The number of active nodes |
| lostNodes | int | The number of lost nodes | | lostNodes | int | The number of lost nodes |
| unhealthyNodes | int | The number of unhealthy nodes | | unhealthyNodes | int | The number of unhealthy nodes |
| decommissioningNodes | int | The number of nodes being decommissioned |
| decommissionedNodes | int | The number of nodes decommissioned | | decommissionedNodes | int | The number of nodes decommissioned |
| rebootedNodes | int | The number of nodes rebooted | | rebootedNodes | int | The number of nodes rebooted |
| shutdownNodes | int | The number of nodes shut down |
### Response Examples ### Response Examples
@ -237,9 +246,11 @@ Response Body:
"totalNodes":1, "totalNodes":1,
"lostNodes":0, "lostNodes":0,
"unhealthyNodes":0, "unhealthyNodes":0,
"decommissioningNodes":0,
"decommissionedNodes":0, "decommissionedNodes":0,
"rebootedNodes":0, "rebootedNodes":0,
"activeNodes":1 "activeNodes":1,
"shutdownNodes":0
} }
} }
``` ```
@ -283,9 +294,11 @@ Response Body:
<totalNodes>1</totalNodes> <totalNodes>1</totalNodes>
<lostNodes>0</lostNodes> <lostNodes>0</lostNodes>
<unhealthyNodes>0</unhealthyNodes> <unhealthyNodes>0</unhealthyNodes>
<decommissioningNodes>0</decommissioningNodes>
<decommissionedNodes>0</decommissionedNodes> <decommissionedNodes>0</decommissionedNodes>
<rebootedNodes>0</rebootedNodes> <rebootedNodes>0</rebootedNodes>
<activeNodes>1</activeNodes> <activeNodes>1</activeNodes>
<shutdownNodes>0</shutdownNodes>
</clusterMetrics> </clusterMetrics>
``` ```
@ -1372,62 +1385,74 @@ Response Body:
"app": "app":
[ [
{ {
"finishedTime" : 1326815598530, "id": "application_1476912658570_0002",
"amContainerLogs" : "http://host.domain.com:8042/node/containerlogs/container_1326815542473_0001_01_000001", "user": "user2",
"trackingUI" : "History",
"state" : "FINISHED",
"user" : "user1",
"id" : "application_1326815542473_0001",
"clusterId" : 1326815542473,
"finalStatus" : "SUCCEEDED",
"amHostHttpAddress" : "host.domain.com:8042",
"amRPCAddress" : "host.domain.com:4201",
"progress" : 100,
"name": "word count", "name": "word count",
"startedTime" : 1326815573334,
"elapsedTime" : 25196,
"diagnostics" : "",
"trackingUrl" : "http://host.domain.com:8088/proxy/application_1326815542473_0001/jobhistory/job/job_1326815542473_1_1",
"queue": "default", "queue": "default",
"state": "FINISHED",
"finalStatus": "SUCCEEDED",
"progress": 100,
"trackingUI": "History",
"trackingUrl": "http://host.domain.com:8088/cluster/app/application_1476912658570_0002",
"diagnostics": "...",
"clusterId": 1476912658570,
"applicationType": "MAPREDUCE",
"applicationTags": "",
"priority": -1,
"startedTime": 1476913457320,
"finishedTime": 1476913761898,
"elapsedTime": 304578,
"amContainerLogs": "http://host.domain.com:8042/node/containerlogs/container_1476912658570_0002_02_000001/user2",
"amHostHttpAddress": "host.domain.com:8042",
"allocatedMB": 0, "allocatedMB": 0,
"allocatedVCores": 0, "allocatedVCores": 0,
"runningContainers": 0, "runningContainers": 0,
"applicationType" : "MAPREDUCE", "memorySeconds": 206464,
"applicationTags" : "", "vcoreSeconds": 201,
"memorySeconds" : 151730, "queueUsagePercentage": 0,
"vcoreSeconds" : 103, "clusterUsagePercentage": 0,
"unmanagedApplication" : "false", "preemptedResourceMB": 0,
"applicationPriority" : 0, "preemptedResourceVCores": 0,
"numNonAMContainerPreempted": 0,
"numAMContainerPreempted": 0,
"logAggregationStatus": "DISABLED",
"unmanagedApplication": false,
"appNodeLabelExpression": "", "appNodeLabelExpression": "",
"amnodeLabelExpression" : "" "amNodeLabelExpression": ""
}, },
{ {
"finishedTime" : 1326815789546, "id": "application_1476912658570_0001",
"amContainerLogs" : "http://host.domain.com:8042/node/containerlogs/container_1326815542473_0002_01_000001",
"trackingUI" : "History",
"state" : "FINISHED",
"user": "user1", "user": "user1",
"id" : "application_1326815542473_0002",
"clusterId" : 1326815542473,
"finalStatus" : "SUCCEEDED",
"amHostHttpAddress" : "host.domain.com:8042",
"amRPCAddress" : "host.domain.com:4202",
"progress" : 100,
"name": "Sleep job", "name": "Sleep job",
"startedTime" : 1326815641380,
"elapsedTime" : 148166,
"diagnostics" : "",
"trackingUrl" : "http://host.domain.com:8088/proxy/application_1326815542473_0002/jobhistory/job/job_1326815542473_2_2",
"queue": "default", "queue": "default",
"state": "FINISHED",
"finalStatus": "SUCCEEDED",
"progress": 100,
"trackingUI": "History",
"trackingUrl": "http://host.domain.com:8088/cluster/app/application_1476912658570_0001",
"diagnostics": "...",
"clusterId": 1476912658570,
"applicationType": "YARN",
"applicationTags": "",
"priority": -1,
"startedTime": 1476913464750,
"finishedTime": 1476913863175,
"elapsedTime": 398425,
"amContainerLogs": "http://host.domain.com:8042/node/containerlogs/container_1476912658570_0001_02_000001/user1",
"amHostHttpAddress": "host.domain.com:8042",
"allocatedMB": 0, "allocatedMB": 0,
"allocatedVCores": 0, "allocatedVCores": 0,
"runningContainers" : 1, "runningContainers": 0,
"applicationType" : "YARN", "memorySeconds": 205410,
"applicationTags" : "tag1", "vcoreSeconds": 200,
"memorySeconds" : 640064, "queueUsagePercentage": 0,
"vcoreSeconds" : 442, "clusterUsagePercentage": 0,
"unmanagedApplication" : "false", "preemptedResourceMB": 0,
"applicationPriority" : 0, "preemptedResourceVCores": 0,
"numNonAMContainerPreempted": 0,
"numAMContainerPreempted": 0,
"logAggregationStatus": "DISABLED",
"unmanagedApplication": false,
"appNodeLabelExpression": "", "appNodeLabelExpression": "",
"amNodeLabelExpression": "" "amNodeLabelExpression": ""
} }
@ -1456,62 +1481,74 @@ Response Body:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<apps> <apps>
<app> <app>
<id>application_1326815542473_0001</id> <id>application_1476912658570_0002</id>
<user>user1</user> <user>user2</user>
<name>word count</name> <name>word count</name>
<applicationType>MAPREDUCE</applicationType>
<applicationTags></applicationTags>
<queue>default</queue> <queue>default</queue>
<state>FINISHED</state> <state>FINISHED</state>
<finalStatus>SUCCEEDED</finalStatus> <finalStatus>SUCCEEDED</finalStatus>
<progress>100.0</progress> <progress>100.0</progress>
<trackingUI>History</trackingUI> <trackingUI>History</trackingUI>
<trackingUrl>http://host.domain.com:8088/proxy/application_1326815542473_0001/jobhistory/job/job_1326815542473_1_1</trackingUrl> <trackingUrl>http://host.domain.com:8088/cluster/app/application_1476912658570_0002</trackingUrl>
<diagnostics/> <diagnostics>...</diagnostics>
<clusterId>1326815542473</clusterId> <clusterId>1476912658570</clusterId>
<startedTime>1326815573334</startedTime> <applicationType>YARN</applicationType>
<finishedTime>1326815598530</finishedTime> <applicationTags></applicationTags>
<elapsedTime>25196</elapsedTime> <priority>-1</priority>
<amContainerLogs>http://host.domain.com:8042/node/containerlogs/container_1326815542473_0001_01_000001</amContainerLogs> <startedTime>1476913457320</startedTime>
<finishedTime>1476913761898</finishedTime>
<elapsedTime>304578</elapsedTime>
<amContainerLogs>http://host.domain.com:8042/node/containerlogs/container_1476912658570_0002_02_000001/user2</amContainerLogs>
<amHostHttpAddress>host.domain.com:8042</amHostHttpAddress> <amHostHttpAddress>host.domain.com:8042</amHostHttpAddress>
<amRPCAddress>host.domain.com:4201</amRPCAddress> <allocatedMB>-1</allocatedMB>
<allocatedMB>0</allocatedMB> <allocatedVCores>-1</allocatedVCores>
<allocatedVCores>0</allocatedVCores> <runningContainers>-1</runningContainers>
<runningContainers>0</runningContainers> <memorySeconds>206464</memorySeconds>
<memorySeconds>151730</memorySeconds> <vcoreSeconds>201</vcoreSeconds>
<vcoreSeconds>103</vcoreSeconds> <queueUsagePercentage>0.0</queueUsagePercentage>
<clusterUsagePercentage>0.0</clusterUsagePercentage>
<preemptedResourceMB>0</preemptedResourceMB>
<preemptedResourceVCores>0</preemptedResourceVCores>
<numNonAMContainerPreempted>0</numNonAMContainerPreempted>
<numAMContainerPreempted>0</numAMContainerPreempted>
<logAggregationStatus>DISABLED</logAggregationStatus>
<unmanagedApplication>false</unmanagedApplication> <unmanagedApplication>false</unmanagedApplication>
<applicationPriority>0</applicationPriority>
<appNodeLabelExpression></appNodeLabelExpression> <appNodeLabelExpression></appNodeLabelExpression>
<amNodeLabelExpression></amNodeLabelExpression> <amNodeLabelExpression></amNodeLabelExpression>
</app> </app>
<app> <app>
<id>application_1326815542473_0002</id> <id>application_1476912658570_0001</id>
<user>user1</user> <user>user1</user>
<name>Sleep job</name> <name>Sleep job</name>
<applicationType>YARN</applicationType>
<applicationTags>tag1</applicationTags>
<queue>default</queue> <queue>default</queue>
<state>FINISHED</state> <state>FINISHED</state>
<finalStatus>SUCCEEDED</finalStatus> <finalStatus>SUCCEEDED</finalStatus>
<progress>100.0</progress> <progress>100.0</progress>
<trackingUI>History</trackingUI> <trackingUI>History</trackingUI>
<trackingUrl>http://host.domain.com:8088/proxy/application_1326815542473_0002/jobhistory/job/job_1326815542473_2_2</trackingUrl> <trackingUrl>http://host.domain.com:8088/cluster/app/application_1476912658570_0001</trackingUrl>
<diagnostics/> <diagnostics>...</diagnostics>
<clusterId>1326815542473</clusterId> <clusterId>1476912658570</clusterId>
<startedTime>1326815641380</startedTime> <applicationType>YARN</applicationType>
<finishedTime>1326815789546</finishedTime> <applicationTags></applicationTags>
<elapsedTime>148166</elapsedTime> <priority>-1</priority>
<amContainerLogs>http://host.domain.com:8042/node/containerlogs/container_1326815542473_0002_01_000001</amContainerLogs> <startedTime>1476913464750</startedTime>
<finishedTime>1476913863175</finishedTime>
<elapsedTime>398425</elapsedTime>
<amContainerLogs>http://host.domain.com:8042/node/containerlogs/container_1476912658570_0001_02_000001/user1</amContainerLogs>
<amHostHttpAddress>host.domain.com:8042</amHostHttpAddress> <amHostHttpAddress>host.domain.com:8042</amHostHttpAddress>
<amRPCAddress>host.domain.com:4202</amRPCAddress> <allocatedMB>-1</allocatedMB>
<allocatedMB>0</allocatedMB> <allocatedVCores>-1</allocatedVCores>
<allocatedVCores>0</allocatedVCores> <runningContainers>-1</runningContainers>
<runningContainers>0</runningContainers> <memorySeconds>205410</memorySeconds>
<memorySeconds>640064</memorySeconds> <vcoreSeconds>200</vcoreSeconds>
<vcoreSeconds>442</vcoreSeconds> <queueUsagePercentage>0.0</queueUsagePercentage>
<clusterUsagePercentage>0.0</clusterUsagePercentage>
<preemptedResourceMB>0</preemptedResourceMB>
<preemptedResourceVCores>0</preemptedResourceVCores>
<numNonAMContainerPreempted>0</numNonAMContainerPreempted>
<numAMContainerPreempted>0</numAMContainerPreempted>
<logAggregationStatus>DISABLED</logAggregationStatus>
<unmanagedApplication>false</unmanagedApplication> <unmanagedApplication>false</unmanagedApplication>
<applicationPriority>0</applicationPriority>
<appNodeLabelExpression></appNodeLabelExpression> <appNodeLabelExpression></appNodeLabelExpression>
<amNodeLabelExpression></amNodeLabelExpression> <amNodeLabelExpression></amNodeLabelExpression>
</app> </app>
@ -1654,15 +1691,17 @@ Note that depending on security settings a user might not be able to see all the
| id | string | The application id | | id | string | The application id |
| user | string | The user who started the application | | user | string | The user who started the application |
| name | string | The application name | | name | string | The application name |
| Application Type | string | The application type |
| queue | string | The queue the application was submitted to | | queue | string | The queue the application was submitted to |
| state | string | The application state according to the ResourceManager - valid values are members of the YarnApplicationState enum: NEW, NEW\_SAVING, SUBMITTED, ACCEPTED, RUNNING, FINISHED, FAILED, KILLED | | state | string | The application state according to the ResourceManager - valid values are members of the YarnApplicationState enum: NEW, NEW\_SAVING, SUBMITTED, ACCEPTED, RUNNING, FINISHED, FAILED, KILLED |
| finalStatus | string | The final status of the application if finished - reported by the application itself - valid values are: UNDEFINED, SUCCEEDED, FAILED, KILLED | | finalStatus | string | The final status of the application if finished - reported by the application itself - valid values are the members of the FinalApplicationStatus enum: UNDEFINED, SUCCEEDED, FAILED, KILLED |
| progress | float | The progress of the application as a percent | | progress | float | The progress of the application as a percent |
| trackingUI | string | Where the tracking url is currently pointing - History (for history server) or ApplicationMaster | | trackingUI | string | Where the tracking url is currently pointing - History (for history server) or ApplicationMaster |
| trackingUrl | string | The web URL that can be used to track the application | | trackingUrl | string | The web URL that can be used to track the application |
| diagnostics | string | Detailed diagnostics information | | diagnostics | string | Detailed diagnostics information |
| clusterId | long | The cluster id | | clusterId | long | The cluster id |
| applicationType | string | The application type |
| applicationTags | string | Comma separated tags of an application |
| priority | string | Priority of the submitted application |
| startedTime | long | The time in which application started (in ms since epoch) | | startedTime | long | The time in which application started (in ms since epoch) |
| finishedTime | long | The time in which the application finished (in ms since epoch) | | finishedTime | long | The time in which the application finished (in ms since epoch) |
| elapsedTime | long | The elapsed time since the application started (in ms) | | elapsedTime | long | The elapsed time since the application started (in ms) |
@ -1674,8 +1713,14 @@ Note that depending on security settings a user might not be able to see all the
| runningContainers | int | The number of containers currently running for the application | | runningContainers | int | The number of containers currently running for the application |
| memorySeconds | long | The amount of memory the application has allocated (megabyte-seconds) | | memorySeconds | long | The amount of memory the application has allocated (megabyte-seconds) |
| vcoreSeconds | long | The amount of CPU resources the application has allocated (virtual core-seconds) | | vcoreSeconds | long | The amount of CPU resources the application has allocated (virtual core-seconds) |
| queueUsagePercentage | float | The percentage of resources of the queue that the app is using |
| clusterUsagePercentage | float | The percentage of resources of the cluster that the app is using. |
| preemptedResourceMB | long | Memory used by preempted container |
| preemptedResourceVCores | long | Number of virtual cores used by preempted container |
| numNonAMContainerPreempted | int | Number of standard containers preempted |
| numAMContainerPreempted | int | Number of application master containers preempted |
| logAggregationStatus | string | Status of log aggregation - valid values are the members of the LogAggregationStatus enum: DISABLED, NOT\_START, RUNNING, RUNNING\_WITH\_FAILURE, SUCCEEDED, FAILED, TIME\_OUT |
| unmanagedApplication | boolean | Is the application unmanaged. | | unmanagedApplication | boolean | Is the application unmanaged. |
| applicationPriority | int | priority of the submitted application |
| appNodeLabelExpression | string | Node Label expression which is used to identify the nodes on which application's containers are expected to run by default.| | appNodeLabelExpression | string | Node Label expression which is used to identify the nodes on which application's containers are expected to run by default.|
| amNodeLabelExpression | string | Node Label expression which is used to identify the node on which application's AM container is expected to run.| | amNodeLabelExpression | string | Node Label expression which is used to identify the node on which application's AM container is expected to run.|
@ -1685,7 +1730,7 @@ Note that depending on security settings a user might not be able to see all the
HTTP Request: HTTP Request:
GET http://<rm http address:port>/ws/v1/cluster/apps/application_1326821518301_0005 GET http://<rm http address:port>/ws/v1/cluster/apps/application_1476912658570_0002
Response Header: Response Header:
@ -1699,28 +1744,38 @@ Response Body:
```json ```json
{ {
"app": { "app": {
"finishedTime" : 1326824991300, "id": "application_1476912658570_0002",
"amContainerLogs" : "http://host.domain.com:8042/node/containerlogs/container_1326821518301_0005_01_000001", "user": "user2",
"trackingUI" : "History", "name": "word count",
"queue": "default",
"state": "FINISHED", "state": "FINISHED",
"user" : "user1",
"id" : "application_1326821518301_0005",
"clusterId" : 1326821518301,
"finalStatus": "SUCCEEDED", "finalStatus": "SUCCEEDED",
"amHostHttpAddress" : "host.domain.com:8042",
"amRPCAddress" : "host.domain.com:4201",
"progress": 100, "progress": 100,
"name" : "Sleep job", "trackingUI": "History",
"applicationType" : "Yarn", "trackingUrl": "http://host.domain.com:8088/cluster/app/application_1476912658570_0002",
"startedTime" : 1326824544552, "diagnostics": "...",
"elapsedTime" : 446748, "clusterId": 1476912658570,
"diagnostics" : "", "applicationType": "YARN",
"trackingUrl" : "http://host.domain.com:8088/proxy/application_1326821518301_0005/jobhistory/job/job_1326821518301_5_5", "applicationTags": "",
"queue" : "a1", "priority": -1,
"memorySeconds" : 151730, "startedTime": 1476913457320,
"vcoreSeconds" : 103, "finishedTime": 1476913761898,
"unmanagedApplication" : "false", "elapsedTime": 304578,
"applicationPriority" : 0, "amContainerLogs": "http://host.domain.com:8042/node/containerlogs/container_1476912658570_0002_02_000001/dr.who",
"amHostHttpAddress": "host.domain.com:8042",
"allocatedMB": -1,
"allocatedVCores": -1,
"runningContainers": -1,
"memorySeconds": 206464,
"vcoreSeconds": 201,
"queueUsagePercentage": 0,
"clusterUsagePercentage": 0,
"preemptedResourceMB": 0,
"preemptedResourceVCores": 0,
"numNonAMContainerPreempted": 0,
"numAMContainerPreempted": 0,
"logAggregationStatus": "DISABLED",
"unmanagedApplication": false,
"appNodeLabelExpression": "", "appNodeLabelExpression": "",
"amNodeLabelExpression": "" "amNodeLabelExpression": ""
} }
@ -1746,27 +1801,38 @@ Response Body:
```xml ```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<app> <app>
<id>application_1326821518301_0005</id> <id>application_1476912658570_0002</id>
<user>user1</user> <user>user2</user>
<name>Sleep job</name> <name>word count</name>
<queue>a1</queue> <queue>default</queue>
<state>FINISHED</state> <state>FINISHED</state>
<finalStatus>SUCCEEDED</finalStatus> <finalStatus>SUCCEEDED</finalStatus>
<progress>100.0</progress> <progress>100.0</progress>
<trackingUI>History</trackingUI> <trackingUI>History</trackingUI>
<trackingUrl>http://host.domain.com:8088/proxy/application_1326821518301_0005/jobhistory/job/job_1326821518301_5_5</trackingUrl> <trackingUrl>http://host.domain.com:8088/cluster/app/application_1476912658570_0002</trackingUrl>
<diagnostics/> <diagnostics>...</diagnostics>
<clusterId>1326821518301</clusterId> <clusterId>1476912658570</clusterId>
<startedTime>1326824544552</startedTime> <applicationType>YARN</applicationType>
<finishedTime>1326824991300</finishedTime> <applicationTags></applicationTags>
<elapsedTime>446748</elapsedTime> <priority>-1</priority>
<amContainerLogs>http://host.domain.com:8042/node/containerlogs/container_1326821518301_0005_01_000001</amContainerLogs> <startedTime>1476913457320</startedTime>
<finishedTime>1476913761898</finishedTime>
<elapsedTime>304578</elapsedTime>
<amContainerLogs>http://host.domain.com:8042/node/containerlogs/container_1476912658570_0002_02_000001/dr.who</amContainerLogs>
<amHostHttpAddress>host.domain.com:8042</amHostHttpAddress> <amHostHttpAddress>host.domain.com:8042</amHostHttpAddress>
<amRPCAddress>host.domain.com:4201</amRPCAddress> <allocatedMB>-1</allocatedMB>
<memorySeconds>151730</memorySeconds> <allocatedVCores>-1</allocatedVCores>
<vcoreSeconds>103</vcoreSeconds> <runningContainers>-1</runningContainers>
<memorySeconds>206464</memorySeconds>
<vcoreSeconds>201</vcoreSeconds>
<queueUsagePercentage>0.0</queueUsagePercentage>
<clusterUsagePercentage>0.0</clusterUsagePercentage>
<preemptedResourceMB>0</preemptedResourceMB>
<preemptedResourceVCores>0</preemptedResourceVCores>
<numNonAMContainerPreempted>0</numNonAMContainerPreempted>
<numAMContainerPreempted>0</numAMContainerPreempted>
<logAggregationStatus>DISABLED</logAggregationStatus>
<unmanagedApplication>false</unmanagedApplication> <unmanagedApplication>false</unmanagedApplication>
<applicationPriority>0</applicationPriority>
<appNodeLabelExpression></appNodeLabelExpression> <appNodeLabelExpression></appNodeLabelExpression>
<amNodeLabelExpression></amNodeLabelExpression> <amNodeLabelExpression></amNodeLabelExpression>
</app> </app>
@ -1925,33 +1991,51 @@ Response Body:
[ [
{ {
"rack":"\/default-rack", "rack":"\/default-rack",
"state":"NEW", "state":"RUNNING",
"id":"h2:1235", "id":"host.domain.com:54158",
"nodeHostName":"h2", "nodeHostName":"host.domain.com",
"nodeHTTPAddress":"h2:2", "nodeHTTPAddress":"host.domain.com:8042",
"healthStatus":"Healthy", "lastHealthUpdate": 1476995346399,
"lastHealthUpdate":1324056895432, "version": "3.0.0-alpha2-SNAPSHOT",
"healthReport":"Healthy", "healthReport":"",
"numContainers":0, "numContainers":0,
"usedMemoryMB":0, "usedMemoryMB":0,
"availMemoryMB":8192, "availMemoryMB":8192,
"usedVirtualCores":0, "usedVirtualCores":0,
"availableVirtualCores":8 "availableVirtualCores":8,
"resourceUtilization":
{
"nodePhysicalMemoryMB":1027,
"nodeVirtualMemoryMB":1027,
"nodeCPUUsage":0.016661113128066063,
"aggregatedContainersPhysicalMemoryMB":0,
"aggregatedContainersVirtualMemoryMB":0,
"containersCPUUsage":0
}
}, },
{ {
"rack":"\/default-rack", "rack":"\/default-rack",
"state":"NEW", "state":"RUNNING",
"id":"h1:1234", "id":"host.domain.com:54158",
"nodeHostName":"h1", "nodeHostName":"host.domain.com",
"nodeHTTPAddress":"h1:2", "nodeHTTPAddress":"host.domain.com:8042",
"healthStatus":"Healthy", "lastHealthUpdate":1476995346399,
"lastHealthUpdate":1324056895092, "version":"3.0.0-alpha2-SNAPSHOT",
"healthReport":"Healthy", "healthReport":"",
"numContainers":0, "numContainers":0,
"usedMemoryMB":0, "usedMemoryMB":0,
"availMemoryMB":8192, "availMemoryMB":8192,
"usedVirtualCores":0, "usedVirtualCores":0,
"availableVirtualCores":8 "availableVirtualCores":8,
"resourceUtilization":
{
"nodePhysicalMemoryMB":1027,
"nodeVirtualMemoryMB":1027,
"nodeCPUUsage":0.016661113128066063,
"aggregatedContainersPhysicalMemoryMB":0,
"aggregatedContainersVirtualMemoryMB":0,
"containersCPUUsage":0
}
} }
] ]
} }
@ -1980,32 +2064,48 @@ Response Body:
<node> <node>
<rack>/default-rack</rack> <rack>/default-rack</rack>
<state>RUNNING</state> <state>RUNNING</state>
<id>h2:1234</id> <id>host1.domain.com:54158</id>
<nodeHostName>h2</nodeHostName> <nodeHostName>host1.domain.com</nodeHostName>
<nodeHTTPAddress>h2:2</nodeHTTPAddress> <nodeHTTPAddress>host1.domain.com:8042</nodeHTTPAddress>
<healthStatus>Healthy</healthStatus> <lastHealthUpdate>1476995346399</lastHealthUpdate>
<lastHealthUpdate>1324333268447</lastHealthUpdate> <version>3.0.0-SNAPSHOT</version>
<healthReport>Healthy</healthReport> <healthReport></healthReport>
<numContainers>0</numContainers> <numContainers>0</numContainers>
<usedMemoryMB>0</usedMemoryMB> <usedMemoryMB>0</usedMemoryMB>
<availMemoryMB>5120</availMemoryMB> <availMemoryMB>8192</availMemoryMB>
<usedVirtualCores>0</usedVirtualCores> <usedVirtualCores>0</usedVirtualCores>
<availableVirtualCores>8</availableVirtualCores> <availableVirtualCores>8</availableVirtualCores>
<resourceUtilization>
<nodePhysicalMemoryMB>1027</nodePhysicalMemoryMB>
<nodeVirtualMemoryMB>1027</nodeVirtualMemoryMB>
<nodeCPUUsage>0.006664445623755455</nodeCPUUsage>
<aggregatedContainersPhysicalMemoryMB>0</aggregatedContainersPhysicalMemoryMB>
<aggregatedContainersVirtualMemoryMB>0</aggregatedContainersVirtualMemoryMB>
<containersCPUUsage>0.0</containersCPUUsage>
</resourceUtilization>
</node> </node>
<node> <node>
<rack>/default-rack</rack> <rack>/default-rack</rack>
<state>RUNNING</state> <state>RUNNING</state>
<id>h1:1234</id> <id>host2.domain.com:54158</id>
<nodeHostName>h1</nodeHostName> <nodeHostName>host2.domain.com</nodeHostName>
<nodeHTTPAddress>h1:2</nodeHTTPAddress> <nodeHTTPAddress>host2.domain.com:8042</nodeHTTPAddress>
<healthStatus>Healthy</healthStatus> <lastHealthUpdate>1476995346399</lastHealthUpdate>
<lastHealthUpdate>1324333268447</lastHealthUpdate> <version>3.0.0-SNAPSHOT</version>
<healthReport>Healthy</healthReport> <healthReport></healthReport>
<numContainers>0</numContainers> <numContainers>0</numContainers>
<usedMemoryMB>0</usedMemoryMB> <usedMemoryMB>0</usedMemoryMB>
<availMemoryMB>5120</availMemoryMB> <availMemoryMB>8192</availMemoryMB>
<usedVirtualCores>0</usedVirtualCores> <usedVirtualCores>0</usedVirtualCores>
<availableVirtualCores>8</availableVirtualCores> <availableVirtualCores>8</availableVirtualCores>
<resourceUtilization>
<nodePhysicalMemoryMB>1027</nodePhysicalMemoryMB>
<nodeVirtualMemoryMB>1027</nodeVirtualMemoryMB>
<nodeCPUUsage>0.006664445623755455</nodeCPUUsage>
<aggregatedContainersPhysicalMemoryMB>0</aggregatedContainersPhysicalMemoryMB>
<aggregatedContainersVirtualMemoryMB>0</aggregatedContainersVirtualMemoryMB>
<containersCPUUsage>0.0</containersCPUUsage>
</resourceUtilization>
</node> </node>
</nodes> </nodes>
``` ```
@ -2038,14 +2138,26 @@ Use the following URI to obtain a Node Object, from a node identified by the nod
| id | string | The node id | | id | string | The node id |
| nodeHostName | string | The host name of the node | | nodeHostName | string | The host name of the node |
| nodeHTTPAddress | string | The nodes HTTP address | | nodeHTTPAddress | string | The nodes HTTP address |
| healthStatus | string | The health status of the node - Healthy or Unhealthy |
| healthReport | string | A detailed health report |
| lastHealthUpdate | long | The last time the node reported its health (in ms since epoch) | | lastHealthUpdate | long | The last time the node reported its health (in ms since epoch) |
| version | string | Version of hadoop running on node |
| healthReport | string | A detailed health report |
| numContainers | int | The total number of containers currently running on the node |
| usedMemoryMB | long | The total amount of memory currently used on the node (in MB) | | usedMemoryMB | long | The total amount of memory currently used on the node (in MB) |
| availMemoryMB | long | The total amount of memory currently available on the node (in MB) | | availMemoryMB | long | The total amount of memory currently available on the node (in MB) |
| usedVirtualCores | long | The total number of vCores currently used on the node | | usedVirtualCores | long | The total number of vCores currently used on the node |
| availableVirtualCores | long | The total number of vCores available on the node | | availableVirtualCores | long | The total number of vCores available on the node |
| numContainers | int | The total number of containers currently running on the node | | resourceUtilization | object | Resource utilization on the node |
The *resourceUtilization* object contains the following elements:
| Item | Data Type | Description |
|:---- |:---- |:---- |
| nodePhysicalMemoryMB | int | Node physical memory utilization |
| nodeVirtualMemoryMB | int | Node virtual memory utilization |
| nodeCPUUsage | double | Node CPU utilization |
| aggregatedContainersPhysicalMemoryMB | int | The aggregated physical memory utilization of the containers |
| aggregatedContainersVirtualMemoryMB | int | The aggregated virtual memory utilization of the containers |
| containersCPUUsage | double | The aggregated CPU utilization of the containers |
### Response Examples ### Response Examples
@ -2069,18 +2181,27 @@ Response Body:
"node": "node":
{ {
"rack":"\/default-rack", "rack":"\/default-rack",
"state":"NEW", "state":"RUNNING",
"id":"h2:1235", "id":"host.domain.com:54158",
"nodeHostName":"h2", "nodeHostName":"host.domain.com",
"nodeHTTPAddress":"h2:2", "nodeHTTPAddress":"host.domain.com:8042",
"healthStatus":"Healthy", "lastHealthUpdate":1476916746399,
"lastHealthUpdate":1324056895432, "version":"3.0.0-SNAPSHOT",
"healthReport":"Healthy", "healthReport":"",
"numContainers":0, "numContainers":0,
"usedMemoryMB":0, "usedMemoryMB":0,
"availMemoryMB":5120, "availMemoryMB":8192,
"usedVirtualCores":0, "usedVirtualCores":0,
"availableVirtualCores":8 "availableVirtualCores":8,
"resourceUtilization":
{
"nodePhysicalMemoryMB": 968,
"nodeVirtualMemoryMB": 968,
"nodeCPUUsage": 0.01332889124751091,
"aggregatedContainersPhysicalMemoryMB": 0,
"aggregatedContainersVirtualMemoryMB": 0,
"containersCPUUsage": 0
}
} }
} }
``` ```
@ -2105,18 +2226,26 @@ Response Body:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<node> <node>
<rack>/default-rack</rack> <rack>/default-rack</rack>
<state>NEW</state> <state>RUNNING</state>
<id>h2:1235</id> <id>host.domain.com:54158</id>
<nodeHostName>h2</nodeHostName> <nodeHostName>host.domain.com</nodeHostName>
<nodeHTTPAddress>h2:2</nodeHTTPAddress> <nodeHTTPAddress>host.domain.com:8042</nodeHTTPAddress>
<healthStatus>Healthy</healthStatus> <lastHealthUpdate>1476916746399</lastHealthUpdate>
<lastHealthUpdate>1324333268447</lastHealthUpdate> <version>3.0.0-SNAPSHOT</version>
<healthReport>Healthy</healthReport> <healthReport></healthReport>
<numContainers>0</numContainers> <numContainers>0</numContainers>
<usedMemoryMB>0</usedMemoryMB> <usedMemoryMB>0</usedMemoryMB>
<availMemoryMB>5120</availMemoryMB> <availMemoryMB>8192</availMemoryMB>
<usedVirtualCores>0</usedVirtualCores> <usedVirtualCores>0</usedVirtualCores>
<availableVirtualCores>5120</availableVirtualCores> <availableVirtualCores>8</availableVirtualCores>
<resourceUtilization>
<nodePhysicalMemoryMB>968</nodePhysicalMemoryMB>
<nodeVirtualMemoryMB>968</nodeVirtualMemoryMB>
<nodeCPUUsage>0.01332889124751091</nodeCPUUsage>
<aggregatedContainersPhysicalMemoryMB>0</aggregatedContainersPhysicalMemoryMB>
<aggregatedContainersVirtualMemoryMB>0</aggregatedContainersVirtualMemoryMB>
<containersCPUUsage>0.0</containersCPUUsage>
</resourceUtilization>
</node> </node>
``` ```