@InterfaceAudience.Private
@InterfaceStability.Evolving
public interface RMWebServiceProtocol
The protocol between clients and the ResourceManager
to
submit/abort jobs and to get information on applications, cluster metrics,
nodes, queues, ACLs and reservations via REST calls.
RMWSConsts.RM_WEB_SERVICE_PATH
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
addToClusterNodeLabels(NodeLabelsInfo newNodeLabels,
javax.servlet.http.HttpServletRequest hsr)
This method adds specific node labels for specific nodes, and it is
reachable by using
RMWSConsts.ADD_NODE_LABELS . |
javax.ws.rs.core.Response |
cancelDelegationToken(javax.servlet.http.HttpServletRequest hsr)
This method cancel the delegation token from the client, and it is
reachable by using
RMWSConsts.DELEGATION_TOKEN . |
RMQueueAclInfo |
checkUserAccessToQueue(String queue,
String username,
String queueAclType,
javax.servlet.http.HttpServletRequest hsr)
This method verifies if an user has access to a specified queue.
|
javax.ws.rs.core.Response |
createNewApplication(javax.servlet.http.HttpServletRequest hsr)
Generates a new ApplicationId which is then sent to the client.
|
javax.ws.rs.core.Response |
createNewReservation(javax.servlet.http.HttpServletRequest hsr)
Generates a new ReservationId which is then sent to the client.
|
javax.ws.rs.core.Response |
deleteReservation(ReservationDeleteRequestInfo resContext,
javax.servlet.http.HttpServletRequest hsr)
Function to delete a Reservation to the RM.
|
String |
dumpSchedulerLogs(String time,
javax.servlet.http.HttpServletRequest hsr)
This method dumps the scheduler logs for the time got in input, and it is
reachable by using
RMWSConsts.SCHEDULER_LOGS . |
ClusterInfo |
get()
This method retrieves the cluster information, and it is reachable by using
RMWSConsts.INFO . |
ActivitiesInfo |
getActivities(javax.servlet.http.HttpServletRequest hsr,
String nodeId,
String groupBy)
This method retrieve all the activities in a specific node, and it is
reachable by using
RMWSConsts.SCHEDULER_ACTIVITIES . |
AppInfo |
getApp(javax.servlet.http.HttpServletRequest hsr,
String appId,
Set<String> unselectedFields)
This method retrieves the report for a specific app, and it is reachable by
using
RMWSConsts.APPS_APPID . |
AppActivitiesInfo |
getAppActivities(javax.servlet.http.HttpServletRequest hsr,
String appId,
String time,
Set<String> requestPriorities,
Set<String> allocationRequestIds,
String groupBy,
String limit,
Set<String> actions,
boolean summarize)
This method retrieves all the activities for a specific app for a specific
period of time, and it is reachable by using
RMWSConsts.SCHEDULER_APP_ACTIVITIES . |
AppAttemptsInfo |
getAppAttempts(javax.servlet.http.HttpServletRequest hsr,
String appId)
This method retrieves all the attempts information for a specific app, and
it is reachable by using
RMWSConsts.APPS_APPID_APPATTEMPTS . |
AppPriority |
getAppPriority(javax.servlet.http.HttpServletRequest hsr,
String appId)
This method retrieves the priority for a specific app, and it is reachable
by using
RMWSConsts.APPS_APPID_PRIORITY . |
AppQueue |
getAppQueue(javax.servlet.http.HttpServletRequest hsr,
String appId)
This method retrieves the queue for a specific app, and it is reachable by
using
RMWSConsts.APPS_APPID_QUEUE . |
AppsInfo |
getApps(javax.servlet.http.HttpServletRequest hsr,
String stateQuery,
Set<String> statesQuery,
String finalStatusQuery,
String userQuery,
String queueQuery,
String count,
String startedBegin,
String startedEnd,
String finishBegin,
String finishEnd,
Set<String> applicationTypes,
Set<String> applicationTags,
String name,
Set<String> unselectedFields)
This method retrieves all the app reports in the cluster, and it is
reachable by using
RMWSConsts.APPS . |
AppState |
getAppState(javax.servlet.http.HttpServletRequest hsr,
String appId)
This method retrieves the state for a specific app, and it is reachable by
using
RMWSConsts.APPS_APPID_STATE . |
ApplicationStatisticsInfo |
getAppStatistics(javax.servlet.http.HttpServletRequest hsr,
Set<String> stateQueries,
Set<String> typeQueries)
This method retrieves all the statistics for a specific app, and it is
reachable by using
RMWSConsts.APP_STATISTICS . |
AppTimeoutInfo |
getAppTimeout(javax.servlet.http.HttpServletRequest hsr,
String appId,
String type)
This method retrieves the timeout information for a specific app with a
specific type, and it is reachable by using
RMWSConsts.APPS_TIMEOUTS_TYPE . |
AppTimeoutsInfo |
getAppTimeouts(javax.servlet.http.HttpServletRequest hsr,
String appId)
This method retrieves the timeout information for a specific app, and it is
reachable by using
RMWSConsts.APPS_TIMEOUTS . |
ClusterInfo |
getClusterInfo()
This method retrieves the cluster information, and it is reachable by using
RMWSConsts.INFO . |
ClusterMetricsInfo |
getClusterMetricsInfo()
This method retrieves the cluster metrics information, and it is reachable
by using
RMWSConsts.METRICS . |
NodeLabelsInfo |
getClusterNodeLabels(javax.servlet.http.HttpServletRequest hsr)
This method retrieves all the node labels in the cluster, and it is
reachable by using
RMWSConsts.GET_NODE_LABELS . |
ClusterUserInfo |
getClusterUserInfo(javax.servlet.http.HttpServletRequest hsr)
This method retrieves the cluster user information, and it is reachable by using
RMWSConsts.CLUSTER_USER_INFO . |
NodeLabelsInfo |
getLabelsOnNode(javax.servlet.http.HttpServletRequest hsr,
String nodeId)
This method retrieves all the node labels for specific node, and it is
reachable by using
RMWSConsts.NODES_NODEID_GETLABELS . |
LabelsToNodesInfo |
getLabelsToNodes(Set<String> labels)
This method retrieves all the node within multiple node labels in the
cluster, and it is reachable by using
RMWSConsts.LABEL_MAPPINGS . |
NodeInfo |
getNode(String nodeId)
This method retrieves a specific node information, and it is reachable by
using
RMWSConsts.NODES_NODEID . |
NodesInfo |
getNodes(String states)
This method retrieves all the nodes information in the cluster, and it is
reachable by using
RMWSConsts.NODES . |
NodeToLabelsInfo |
getNodeToLabels(javax.servlet.http.HttpServletRequest hsr)
This method retrieves all the node labels with the respective nodes in the
cluster, and it is reachable by using
RMWSConsts.GET_NODE_TO_LABELS . |
SchedulerTypeInfo |
getSchedulerInfo()
This method retrieves the current scheduler status, and it is reachable by
using
RMWSConsts.SCHEDULER . |
javax.ws.rs.core.Response |
listReservation(String queue,
String reservationId,
long startTime,
long endTime,
boolean includeResourceAllocations,
javax.servlet.http.HttpServletRequest hsr)
Function to retrieve a list of all the reservations.
|
javax.ws.rs.core.Response |
postDelegationToken(DelegationToken tokenData,
javax.servlet.http.HttpServletRequest hsr)
This method posts a delegation token from the client, and it is reachable
by using
RMWSConsts.DELEGATION_TOKEN . |
javax.ws.rs.core.Response |
postDelegationTokenExpiration(javax.servlet.http.HttpServletRequest hsr)
This method updates the expiration for a delegation token from the client,
and it is reachable by using
RMWSConsts.DELEGATION_TOKEN_EXPIRATION . |
javax.ws.rs.core.Response |
removeFromCluserNodeLabels(Set<String> oldNodeLabels,
javax.servlet.http.HttpServletRequest hsr)
This method removes all the node labels for specific nodes, and it is
reachable by using
RMWSConsts.REMOVE_NODE_LABELS . |
javax.ws.rs.core.Response |
replaceLabelsOnNode(Set<String> newNodeLabelsName,
javax.servlet.http.HttpServletRequest hsr,
String nodeId)
This method replaces all the node labels for specific node, and it is
reachable by using
RMWSConsts.NODES_NODEID_REPLACE_LABELS . |
javax.ws.rs.core.Response |
replaceLabelsOnNodes(NodeToLabelsEntryList newNodeToLabels,
javax.servlet.http.HttpServletRequest hsr)
This method replaces all the node labels for specific nodes, and it is
reachable by using
RMWSConsts.REPLACE_NODE_TO_LABELS . |
javax.ws.rs.core.Response |
signalToContainer(String containerId,
String command,
javax.servlet.http.HttpServletRequest req)
This method sends a signal to container.
|
javax.ws.rs.core.Response |
submitApplication(ApplicationSubmissionContextInfo newApp,
javax.servlet.http.HttpServletRequest hsr)
Function to submit an app to the RM.
|
javax.ws.rs.core.Response |
submitReservation(ReservationSubmissionRequestInfo resContext,
javax.servlet.http.HttpServletRequest hsr)
Function to submit a Reservation to the RM.This method is reachable by
using
RMWSConsts.RESERVATION_SUBMIT . |
javax.ws.rs.core.Response |
updateApplicationPriority(AppPriority targetPriority,
javax.servlet.http.HttpServletRequest hsr,
String appId)
This method updates the priority for a specific application, and it is
reachable by using
RMWSConsts.APPS_APPID_PRIORITY . |
javax.ws.rs.core.Response |
updateApplicationTimeout(AppTimeoutInfo appTimeout,
javax.servlet.http.HttpServletRequest hsr,
String appId)
This method updates the timeout information for a specific app, and it is
reachable by using
RMWSConsts.APPS_TIMEOUT . |
javax.ws.rs.core.Response |
updateAppQueue(AppQueue targetQueue,
javax.servlet.http.HttpServletRequest hsr,
String appId)
This method updates the queue for a specific application, and it is
reachable by using
RMWSConsts.APPS_APPID_QUEUE . |
javax.ws.rs.core.Response |
updateAppState(AppState targetState,
javax.servlet.http.HttpServletRequest hsr,
String appId)
This method updates the state of the app in input, and it is reachable by
using
RMWSConsts.APPS_APPID_STATE . |
ResourceInfo |
updateNodeResource(javax.servlet.http.HttpServletRequest hsr,
String nodeId,
ResourceOptionInfo resourceOption)
This method changes the resources of a specific node, and it is reachable
by using
RMWSConsts.NODE_RESOURCE . |
javax.ws.rs.core.Response |
updateReservation(ReservationUpdateRequestInfo resContext,
javax.servlet.http.HttpServletRequest hsr)
Function to update a Reservation to the RM.
|
ClusterInfo get()
RMWSConsts.INFO
.ClusterInfo getClusterInfo()
RMWSConsts.INFO
.ClusterUserInfo getClusterUserInfo(javax.servlet.http.HttpServletRequest hsr)
RMWSConsts.CLUSTER_USER_INFO
.ClusterMetricsInfo getClusterMetricsInfo()
RMWSConsts.METRICS
.ApplicationClientProtocol.getClusterMetrics(org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest)
SchedulerTypeInfo getSchedulerInfo()
RMWSConsts.SCHEDULER
.String dumpSchedulerLogs(String time, javax.servlet.http.HttpServletRequest hsr) throws IOException
RMWSConsts.SCHEDULER_LOGS
.time
- the period of time. It is a FormParam.hsr
- the servlet requestIOException
- when it cannot create dump log fileNodesInfo getNodes(String states)
RMWSConsts.NODES
.states
- the states we want to filter. It is a QueryParam.ApplicationClientProtocol.getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)
NodeInfo getNode(String nodeId)
RMWSConsts.NODES_NODEID
.nodeId
- the node we want to retrieve the information. It is a
PathParam.ResourceInfo updateNodeResource(javax.servlet.http.HttpServletRequest hsr, String nodeId, ResourceOptionInfo resourceOption) throws org.apache.hadoop.security.authorize.AuthorizationException
RMWSConsts.NODE_RESOURCE
.hsr
- The servlet request.nodeId
- The node we want to retrieve the information for.
It is a PathParam.resourceOption
- The resource change.org.apache.hadoop.security.authorize.AuthorizationException
- If the user is not authorized.AppsInfo getApps(javax.servlet.http.HttpServletRequest hsr, String stateQuery, Set<String> statesQuery, String finalStatusQuery, String userQuery, String queueQuery, String count, String startedBegin, String startedEnd, String finishBegin, String finishEnd, Set<String> applicationTypes, Set<String> applicationTags, String name, Set<String> unselectedFields)
RMWSConsts.APPS
.hsr
- the servlet requeststateQuery
- right now the stateQuery is deprecated. It is a
QueryParam.statesQuery
- filter the result by states. It is a QueryParam.finalStatusQuery
- filter the result by final states. It is a
QueryParam.userQuery
- filter the result by user. It is a QueryParam.queueQuery
- filter the result by queue. It is a QueryParam.count
- set a limit of the result. It is a QueryParam.startedBegin
- filter the result by started begin time. It is a
QueryParam.startedEnd
- filter the result by started end time. It is a
QueryParam.finishBegin
- filter the result by finish begin time. It is a
QueryParam.finishEnd
- filter the result by finish end time. It is a QueryParam.applicationTypes
- filter the result by types. It is a QueryParam.applicationTags
- filter the result by tags. It is a QueryParam.name
- filter the name of the application. It is a QueryParam.unselectedFields
- De-selected params to avoid from report. It is a
QueryParam.ApplicationBaseProtocol.getApplications(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest)
ActivitiesInfo getActivities(javax.servlet.http.HttpServletRequest hsr, String nodeId, String groupBy)
RMWSConsts.SCHEDULER_ACTIVITIES
.hsr
- the servlet requestnodeId
- the node we want to retrieve the activities. It is a
QueryParam.groupBy
- the groupBy type by which the activities should be
aggregated. It is a QueryParam.AppActivitiesInfo getAppActivities(javax.servlet.http.HttpServletRequest hsr, String appId, String time, Set<String> requestPriorities, Set<String> allocationRequestIds, String groupBy, String limit, Set<String> actions, boolean summarize)
RMWSConsts.SCHEDULER_APP_ACTIVITIES
.hsr
- the servlet requestappId
- the applicationId we want to retrieve the activities. It is a
QueryParam.time
- for how long we want to retrieve the activities. It is a
QueryParam.requestPriorities
- the request priorities we want to retrieve the
activities. It is a QueryParam.allocationRequestIds
- the allocation request ids we want to retrieve
the activities. It is a QueryParam.groupBy
- the groupBy type by which the activities should be
aggregated. It is a QueryParam.limit
- set a limit of the result. It is a QueryParam.actions
- the required actions of app activities. It is a QueryParam.summarize
- whether app activities in multiple scheduling processes
need to be summarized. It is a QueryParam.ApplicationStatisticsInfo getAppStatistics(javax.servlet.http.HttpServletRequest hsr, Set<String> stateQueries, Set<String> typeQueries)
RMWSConsts.APP_STATISTICS
.hsr
- the servlet requeststateQueries
- filter the result by states. It is a QueryParam.typeQueries
- filter the result by type names. It is a QueryParam.AppInfo getApp(javax.servlet.http.HttpServletRequest hsr, String appId, Set<String> unselectedFields)
RMWSConsts.APPS_APPID
.hsr
- the servlet requestappId
- the Id of the application we want the report. It is a
PathParam.unselectedFields
- De-selected param list to avoid from report. It is
a QueryParam.ApplicationBaseProtocol.getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)
AppState getAppState(javax.servlet.http.HttpServletRequest hsr, String appId) throws org.apache.hadoop.security.authorize.AuthorizationException
RMWSConsts.APPS_APPID_STATE
.hsr
- the servlet requestappId
- the Id of the application we want the state. It is a
PathParam.org.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorizedjavax.ws.rs.core.Response updateAppState(AppState targetState, javax.servlet.http.HttpServletRequest hsr, String appId) throws org.apache.hadoop.security.authorize.AuthorizationException, org.apache.hadoop.yarn.exceptions.YarnException, InterruptedException, IOException
RMWSConsts.APPS_APPID_STATE
.targetState
- the target state for the app. It is a content param.hsr
- the servlet requestappId
- the Id of the application we want to update the state. It is a
PathParam.org.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorized to invoke this
methodorg.apache.hadoop.yarn.exceptions.YarnException
- if app does not existInterruptedException
- if interruptedIOException
- if doAs action throws an IOExceptionNodeToLabelsInfo getNodeToLabels(javax.servlet.http.HttpServletRequest hsr) throws IOException
RMWSConsts.GET_NODE_TO_LABELS
.hsr
- the servlet requestIOException
- if an IOException happenedApplicationClientProtocol.getNodeToLabels(org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest)
LabelsToNodesInfo getLabelsToNodes(Set<String> labels) throws IOException
RMWSConsts.LABEL_MAPPINGS
.labels
- filter the result by node labels. It is a QueryParam.IOException
- if an IOException happenedApplicationClientProtocol.getLabelsToNodes(org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest)
javax.ws.rs.core.Response replaceLabelsOnNodes(NodeToLabelsEntryList newNodeToLabels, javax.servlet.http.HttpServletRequest hsr) throws Exception
RMWSConsts.REPLACE_NODE_TO_LABELS
.newNodeToLabels
- the list of new labels. It is a content param.hsr
- the servlet requestException
- if an exception happenedResourceManagerAdministrationProtocol.replaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest)
javax.ws.rs.core.Response replaceLabelsOnNode(Set<String> newNodeLabelsName, javax.servlet.http.HttpServletRequest hsr, String nodeId) throws Exception
RMWSConsts.NODES_NODEID_REPLACE_LABELS
.newNodeLabelsName
- the list of new labels. It is a QueryParam.hsr
- the servlet requestnodeId
- the node we want to replace the node labels. It is a
PathParam.Exception
- if an exception happenedResourceManagerAdministrationProtocol.replaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest)
NodeLabelsInfo getClusterNodeLabels(javax.servlet.http.HttpServletRequest hsr) throws IOException
RMWSConsts.GET_NODE_LABELS
.hsr
- the servlet requestIOException
- if an IOException happenedApplicationClientProtocol.getClusterNodeLabels(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest)
javax.ws.rs.core.Response addToClusterNodeLabels(NodeLabelsInfo newNodeLabels, javax.servlet.http.HttpServletRequest hsr) throws Exception
RMWSConsts.ADD_NODE_LABELS
.newNodeLabels
- the node labels to add. It is a content param.hsr
- the servlet requestException
- in case of bad requestResourceManagerAdministrationProtocol.addToClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsRequest)
javax.ws.rs.core.Response removeFromCluserNodeLabels(Set<String> oldNodeLabels, javax.servlet.http.HttpServletRequest hsr) throws Exception
RMWSConsts.REMOVE_NODE_LABELS
.oldNodeLabels
- the node labels to remove. It is a QueryParam.hsr
- the servlet requestException
- in case of bad requestResourceManagerAdministrationProtocol.removeFromClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsRequest)
NodeLabelsInfo getLabelsOnNode(javax.servlet.http.HttpServletRequest hsr, String nodeId) throws IOException
RMWSConsts.NODES_NODEID_GETLABELS
.hsr
- the servlet requestnodeId
- the node we want to get all the node labels. It is a
PathParam.IOException
- if an IOException happenedAppPriority getAppPriority(javax.servlet.http.HttpServletRequest hsr, String appId) throws org.apache.hadoop.security.authorize.AuthorizationException
RMWSConsts.APPS_APPID_PRIORITY
.hsr
- the servlet requestappId
- the app we want to get the priority. It is a PathParam.org.apache.hadoop.security.authorize.AuthorizationException
- in case of the user is not authorizedjavax.ws.rs.core.Response updateApplicationPriority(AppPriority targetPriority, javax.servlet.http.HttpServletRequest hsr, String appId) throws org.apache.hadoop.security.authorize.AuthorizationException, org.apache.hadoop.yarn.exceptions.YarnException, InterruptedException, IOException
RMWSConsts.APPS_APPID_PRIORITY
.targetPriority
- the priority we want to set for the app. It is a
content param.hsr
- the servlet requestappId
- the application we want to update its priority. It is a
PathParam.org.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authenticatedorg.apache.hadoop.yarn.exceptions.YarnException
- if the target is nullIOException
- if the update fails.InterruptedException
- if interrupted.AppQueue getAppQueue(javax.servlet.http.HttpServletRequest hsr, String appId) throws org.apache.hadoop.security.authorize.AuthorizationException
RMWSConsts.APPS_APPID_QUEUE
.hsr
- the servlet requestappId
- the application we want to retrieve its queue. It is a
PathParam.org.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authenticatedjavax.ws.rs.core.Response updateAppQueue(AppQueue targetQueue, javax.servlet.http.HttpServletRequest hsr, String appId) throws org.apache.hadoop.security.authorize.AuthorizationException, org.apache.hadoop.yarn.exceptions.YarnException, InterruptedException, IOException
RMWSConsts.APPS_APPID_QUEUE
.targetQueue
- the queue we want to set. It is a content param.hsr
- the servlet requestappId
- the application we want to change its queue. It is a
PathParam.org.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authenticatedorg.apache.hadoop.yarn.exceptions.YarnException
- if the app is not foundIOException
- if the update fails.InterruptedException
- if interrupted.javax.ws.rs.core.Response createNewApplication(javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException, IOException, InterruptedException
RMWSConsts.APPS_NEW_APPLICATION
.hsr
- the servlet requestorg.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorized to invoke this
methodIOException
- if the creation failsInterruptedException
- if interruptedApplicationClientProtocol.getNewApplication(org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest)
javax.ws.rs.core.Response submitApplication(ApplicationSubmissionContextInfo newApp, javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException, IOException, InterruptedException
RMWSConsts.APPS
.newApp
- structure containing information to construct the
ApplicationSubmissionContext. It is a content param.hsr
- the servlet requestorg.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorized to invoke this
methodIOException
- if the submission failedInterruptedException
- if interruptedApplicationClientProtocol.submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)
javax.ws.rs.core.Response postDelegationToken(DelegationToken tokenData, javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException, IOException, InterruptedException, Exception
RMWSConsts.DELEGATION_TOKEN
.tokenData
- the token to delegate. It is a content param.hsr
- the servlet requestorg.apache.hadoop.security.authorize.AuthorizationException
- if Kerberos auth failedIOException
- if the delegation failedInterruptedException
- if interruptedException
- in case of bad requestApplicationBaseProtocol.getDelegationToken(org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest)
javax.ws.rs.core.Response postDelegationTokenExpiration(javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException, IOException, Exception
RMWSConsts.DELEGATION_TOKEN_EXPIRATION
.hsr
- the servlet requestorg.apache.hadoop.security.authorize.AuthorizationException
- if Kerberos auth failedIOException
- if the delegation failedException
- in case of bad requestApplicationBaseProtocol.renewDelegationToken(org.apache.hadoop.yarn.api.protocolrecords.RenewDelegationTokenRequest)
javax.ws.rs.core.Response cancelDelegationToken(javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException, IOException, InterruptedException, Exception
RMWSConsts.DELEGATION_TOKEN
.hsr
- the servlet requestorg.apache.hadoop.security.authorize.AuthorizationException
- if Kerberos auth failedIOException
- if the delegation failedInterruptedException
- if interruptedException
- in case of bad requestApplicationBaseProtocol.cancelDelegationToken(org.apache.hadoop.yarn.api.protocolrecords.CancelDelegationTokenRequest)
javax.ws.rs.core.Response createNewReservation(javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException, IOException, InterruptedException
RMWSConsts.RESERVATION_NEW
.hsr
- the servlet requestorg.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorized to invoke this
method.IOException
- if creation failedInterruptedException
- if interruptedApplicationClientProtocol.getNewReservation(org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest)
javax.ws.rs.core.Response submitReservation(ReservationSubmissionRequestInfo resContext, javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException, IOException, InterruptedException
RMWSConsts.RESERVATION_SUBMIT
.resContext
- provides information to construct the
ReservationSubmissionRequest. It is a content param.hsr
- the servlet requestorg.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorized to invoke this
methodIOException
- if creation failedInterruptedException
- if interruptedApplicationClientProtocol.submitReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest)
javax.ws.rs.core.Response updateReservation(ReservationUpdateRequestInfo resContext, javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException, IOException, InterruptedException
RMWSConsts.RESERVATION_UPDATE
.resContext
- provides information to construct the
ReservationUpdateRequest. It is a content param.hsr
- the servlet requestorg.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorized to invoke this
methodIOException
- if the operation failedInterruptedException
- if interruptedApplicationClientProtocol.updateReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest)
javax.ws.rs.core.Response deleteReservation(ReservationDeleteRequestInfo resContext, javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException, IOException, InterruptedException
RMWSConsts.RESERVATION_DELETE
.resContext
- provides information to construct the
ReservationDeleteRequest. It is a content param.hsr
- the servlet requestorg.apache.hadoop.security.authorize.AuthorizationException
- when the user group information cannot be
retrieved.IOException
- when a ReservationDeleteRequest
cannot be
created from the ReservationDeleteRequestInfo
. This
exception is also thrown on
ClientRMService.deleteReservation
invokation failure.InterruptedException
- if doAs action throws an InterruptedException.ApplicationClientProtocol.deleteReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest)
javax.ws.rs.core.Response listReservation(String queue, String reservationId, long startTime, long endTime, boolean includeResourceAllocations, javax.servlet.http.HttpServletRequest hsr) throws Exception
RMWSConsts.RESERVATION_LIST
.queue
- filter the result by queue. It is a QueryParam.reservationId
- filter the result by reservationId. It is a
QueryParam.startTime
- filter the result by start time. It is a QueryParam.endTime
- filter the result by end time. It is a QueryParam.includeResourceAllocations
- true if the resource allocation should be
in the result, false otherwise. It is a QueryParam.hsr
- the servlet requestException
- in case of bad requestApplicationClientProtocol.listReservations(org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest)
AppTimeoutInfo getAppTimeout(javax.servlet.http.HttpServletRequest hsr, String appId, String type) throws org.apache.hadoop.security.authorize.AuthorizationException
RMWSConsts.APPS_TIMEOUTS_TYPE
.hsr
- the servlet requestappId
- the application we want to get the timeout. It is a PathParam.type
- the type of the timeouts. It is a PathParam.org.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorizedAppTimeoutsInfo getAppTimeouts(javax.servlet.http.HttpServletRequest hsr, String appId) throws org.apache.hadoop.security.authorize.AuthorizationException
RMWSConsts.APPS_TIMEOUTS
.hsr
- the servlet requestappId
- the application we want to get the timeouts. It is a
PathParam.org.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorizedjavax.ws.rs.core.Response updateApplicationTimeout(AppTimeoutInfo appTimeout, javax.servlet.http.HttpServletRequest hsr, String appId) throws org.apache.hadoop.security.authorize.AuthorizationException, org.apache.hadoop.yarn.exceptions.YarnException, InterruptedException, IOException
RMWSConsts.APPS_TIMEOUT
.appTimeout
- the appTimeoutInfo. It is a content param.hsr
- the servlet requestappId
- the application we want to update. It is a PathParam.org.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorized to invoke this
methodorg.apache.hadoop.yarn.exceptions.YarnException
- in case of bad requestIOException
- if the operation failedInterruptedException
- if interruptedApplicationClientProtocol.updateApplicationTimeouts(org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest)
AppAttemptsInfo getAppAttempts(javax.servlet.http.HttpServletRequest hsr, String appId)
RMWSConsts.APPS_APPID_APPATTEMPTS
.hsr
- the servlet requestappId
- the application we want to get the attempts. It is a
PathParam.ApplicationBaseProtocol.getApplicationAttempts(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest)
RMQueueAclInfo checkUserAccessToQueue(String queue, String username, String queueAclType, javax.servlet.http.HttpServletRequest hsr) throws org.apache.hadoop.security.authorize.AuthorizationException
queue
- queueusername
- userqueueAclType
- acl type of queue, it could be
SUBMIT_APPLICATIONS/ADMINISTER_QUEUEhsr
- requestorg.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorized to invoke this
method.javax.ws.rs.core.Response signalToContainer(String containerId, String command, javax.servlet.http.HttpServletRequest req) throws org.apache.hadoop.security.authorize.AuthorizationException
containerId
- containerIdcommand
- signal command, it could be OUTPUT_THREAD_DUMP/
GRACEFUL_SHUTDOWN/FORCEFUL_SHUTDOWNreq
- requestorg.apache.hadoop.security.authorize.AuthorizationException
- if the user is not authorized to invoke this
method.Copyright © 2008–2020 Apache Software Foundation. All rights reserved.