org.apache.hadoop.yarn.server.nodemanager.webapp

Class NMWebServices

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.webapp.NMWebServices

@Path(value="/ws/v1/node")
public class NMWebServices
extends Object

Constructor Summary

Constructors

Constructor and Description
NMWebServices(Context nm, ResourceView view, org.apache.hadoop.yarn.webapp.WebApp webapp)
NMWebServices(Context nm, ResourceView view, org.apache.hadoop.yarn.webapp.WebApp webapp, javax.servlet.http.HttpServletResponse response)

Method Summary

Modifier and Type	Method and Description
NodeInfo	get()
AuxiliaryServicesInfo	getAuxiliaryServices(javax.servlet.http.HttpServletRequest hsr)
javax.ws.rs.core.Response	getContainerLogFile(String containerIdStr, String filename, String format, String size) Returns the contents of a container's log file in plain text.
javax.ws.rs.core.Response	getContainerLogsInfo(javax.servlet.http.HttpServletRequest hsr, javax.servlet.http.HttpServletResponse res, String containerIdStr) Returns log file's name as well as current file size for a container.
javax.ws.rs.core.Response	getLogs(String containerIdStr, String filename, String format, String size) Returns the contents of a container's log file in plain text.
Object	getNMResourceInfo(String resourceName)
AppInfo	getNodeApp(String appId)
AppsInfo	getNodeApps(javax.servlet.http.HttpServletRequest hsr, String stateQuery, String userQuery)
ContainerInfo	getNodeContainer(javax.servlet.http.HttpServletRequest hsr, String id)
ContainersInfo	getNodeContainers(javax.servlet.http.HttpServletRequest hsr)
NodeInfo	getNodeInfo()
protected Boolean	hasAccess(String user, org.apache.hadoop.yarn.api.records.ApplicationId appId, javax.servlet.http.HttpServletRequest hsr)
protected Boolean	hasAdminAccess(javax.servlet.http.HttpServletRequest hsr)
javax.ws.rs.core.Response	putAuxiliaryServices(javax.servlet.http.HttpServletRequest req, AuxServiceRecords services)
javax.ws.rs.core.Response	syncYarnSysFS(javax.servlet.http.HttpServletRequest req, String user, String appId, String spec)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NMWebServices

@Inject
public NMWebServices(Context nm,
                             ResourceView view,
                             org.apache.hadoop.yarn.webapp.WebApp webapp)

NMWebServices

public NMWebServices(Context nm,
                     ResourceView view,
                     org.apache.hadoop.yarn.webapp.WebApp webapp,
                     javax.servlet.http.HttpServletResponse response)

Method Detail

get

@GET
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public NodeInfo get()

getNodeInfo

@GET
 @Path(value="/info")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public NodeInfo getNodeInfo()

getNodeApps

@GET
 @Path(value="/apps")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public AppsInfo getNodeApps(@Context
                                                                                                                                              javax.servlet.http.HttpServletRequest hsr,
                                                                                                                                              @QueryParam(value="state")
                                                                                                                                              String stateQuery,
                                                                                                                                              @QueryParam(value="user")
                                                                                                                                              String userQuery)

getNodeApp

@GET
 @Path(value="/apps/{appid}")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public AppInfo getNodeApp(@PathParam(value="appid")
                                                                                                                                                    String appId)

getNodeContainers

@GET
 @Path(value="/containers")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public ContainersInfo getNodeContainers(@Context
                                                                                                                                                                javax.servlet.http.HttpServletRequest hsr)

getNodeContainer

@GET
 @Path(value="/containers/{containerid}")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public ContainerInfo getNodeContainer(@Context
                                                                                                                                                                            javax.servlet.http.HttpServletRequest hsr,
                                                                                                                                                                            @PathParam(value="containerid")
                                                                                                                                                                            String id)

getContainerLogsInfo

@GET
 @Path(value="/containers/{containerid}/logs")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public javax.ws.rs.core.Response getContainerLogsInfo(@Context
                                                                                                                                                                                                 javax.servlet.http.HttpServletRequest hsr,
                                                                                                                                                                                                 @Context
                                                                                                                                                                                                 javax.servlet.http.HttpServletResponse res,
                                                                                                                                                                                                 @PathParam(value="containerid")
                                                                                                                                                                                                 String containerIdStr)

Returns log file's name as well as current file size for a container.

Parameters:

hsr - HttpServletRequest

res - HttpServletResponse

containerIdStr - The container ID

Returns:

The log file's name and current file size

getContainerLogFile

@GET
 @Path(value="/containers/{containerid}/logs/{filename}")
 @Produces(value="text/plain; charset=utf-8")
 @InterfaceAudience.Public
 @InterfaceStability.Unstable
public javax.ws.rs.core.Response getContainerLogFile(@PathParam(value="containerid")
                                                                                                                                                                                                                           String containerIdStr,
                                                                                                                                                                                                                           @PathParam(value="filename")
                                                                                                                                                                                                                           String filename,
                                                                                                                                                                                                                           @QueryParam(value="format")
                                                                                                                                                                                                                           String format,
                                                                                                                                                                                                                           @QueryParam(value="size")
                                                                                                                                                                                                                           String size)

Returns the contents of a container's log file in plain text. Only works for containers that are still in the NodeManager's memory, so logs are no longer available after the corresponding application is no longer running.

Parameters:

containerIdStr - The container ID

filename - The name of the log file

format - The content type

size - the size of the log file

Returns:

The contents of the container's log file

getLogs

@GET
 @Path(value="/containerlogs/{containerid}/{filename}")
 @Produces(value="text/plain; charset=utf-8")
 @InterfaceAudience.Public
 @InterfaceStability.Unstable
public javax.ws.rs.core.Response getLogs(@PathParam(value="containerid")
                                                                                                                                                                                                             String containerIdStr,
                                                                                                                                                                                                             @PathParam(value="filename")
                                                                                                                                                                                                             String filename,
                                                                                                                                                                                                             @QueryParam(value="format")
                                                                                                                                                                                                             String format,
                                                                                                                                                                                                             @QueryParam(value="size")
                                                                                                                                                                                                             String size)

Returns the contents of a container's log file in plain text. Only works for containers that are still in the NodeManager's memory, so logs are no longer available after the corresponding application is no longer running.

Parameters:

containerIdStr - The container ID

filename - The name of the log file

format - The content type

size - the size of the log file

Returns:

The contents of the container's log file

getNMResourceInfo

@GET
 @Path(value="/resources/{resourcename}")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public Object getNMResourceInfo(@PathParam(value="resourcename")
                                                                                                                                                                      String resourceName)
                                                                                                                                                               throws org.apache.hadoop.yarn.exceptions.YarnException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

getAuxiliaryServices

@GET
 @Path(value="/auxiliaryservices")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public AuxiliaryServicesInfo getAuxiliaryServices(@Context
                                                                                                                                                                                 javax.servlet.http.HttpServletRequest hsr)

putAuxiliaryServices

@PUT
 @Path(value="/auxiliaryservices")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public javax.ws.rs.core.Response putAuxiliaryServices(@Context
                                                                                                                                                                                     javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                                     AuxServiceRecords services)

syncYarnSysFS

@PUT
 @Path(value="/yarn/sysfs/{user}/{appId}")
 @Produces(value={"application/json; charset=utf-8","application/xml; charset=utf-8"})
public javax.ws.rs.core.Response syncYarnSysFS(@Context
                                                                                                                                                                                      javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                                      @PathParam(value="user")
                                                                                                                                                                                      String user,
                                                                                                                                                                                      @PathParam(value="appId")
                                                                                                                                                                                      String appId,
                                                                                                                                                                                      String spec)

hasAccess

protected Boolean hasAccess(String user,
                            org.apache.hadoop.yarn.api.records.ApplicationId appId,
                            javax.servlet.http.HttpServletRequest hsr)

hasAdminAccess

protected Boolean hasAdminAccess(javax.servlet.http.HttpServletRequest hsr)