Skip to content

YARN-10303. Fixing rest api example, status code error and other typos in ResourceManagerRest.md #4221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 26, 2022
Merged

YARN-10303. Fixing rest api example, status code error and other typos in ResourceManagerRest.md #4221

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c1abce0
YARN-10303. Correcting rest api example in ResourceManagerRest.md
Apr 22, 2022
2f4f71c
YARN-9429. Fixing status code error in ResourceManager REST api doc
Apr 24, 2022
4a495a8
fixing typos
hotcodemacha Apr 25, 2022
aab8a75
fixing format
hotcodemacha Apr 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions ...n-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/ResourceManagerRest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1605,11 +1605,11 @@ Current supported items:

| Item | Data Type | Description |
|:---- |:---- |:---- |
| resouceRequests | comma separated string | Skip resource requests of application in return |
| resourceRequests | comma separated string | Skip resource requests of application in return |

e.g:

* http://rm-http-address:port/ws/v1/cluster/apps?deSelects=resouceRequests
* http://rm-http-address:port/ws/v1/cluster/apps?deSelects=resourceRequests


### Response Examples
Expand Down Expand Up @@ -1979,7 +1979,7 @@ With the Application Statistics API, you can obtain a collection of triples, eac

### Query Parameters Required

Two paramters can be specified. The parameters are case insensitive.
Two parameters can be specified. The parameters are case insensitive.

* states - states of the applications, specified as a comma-separated list. If states is not provided, the API will enumerate all application states and return the counts of them.
* applicationTypes - types of the applications, specified as a comma-separated list. If applicationTypes is not provided, the API will count the applications of any application type. In this case, the response shows * to indicate any application type. Note that we only support at most one applicationType temporarily. Otherwise, users will expect an BadRequestException.
Expand Down Expand Up @@ -3062,7 +3062,7 @@ Response Body:
Cluster Writeable APIs
----------------------

The setions below refer to APIs which allow to create and modify applications. These APIs are currently in alpha and may change in the future.
The sections below refer to APIs which allow to create and modify applications. These APIs are currently in alpha and may change in the future.

Cluster New Application API
---------------------------
Expand Down Expand Up @@ -3092,7 +3092,7 @@ The NewApplication response contains the following elements:
| application-id | string | The newly created application id |
| maximum-resource-capabilities | object | The maximum resource capabilities available on this cluster |

The *maximum-resource-capabilites* object contains the following elements:
The *maximum-resource-capabilities* object contains the following elements:

| Item | Data Type | Description |
|:---- |:---- |:---- |
Expand Down Expand Up @@ -3186,7 +3186,7 @@ Please note that this feature is currently in the alpha stage and may change in
| resource | object | The resources the application master requires, described below |
| application-type | string | The application type(MapReduce, Pig, Hive, etc) |
| keep-containers-across-application-attempts | boolean | Should YARN keep the containers used by this application instead of destroying them |
| application-tags | object | List of application tags, please see the request examples on how to speciy the tags |
| application-tags | object | List of application tags, please see the request examples on how to specify the tags |
| log-aggregation-context| object | Represents all of the information needed by the NodeManager to handle the logs for this application |
| attempt-failures-validity-interval| long | The failure number will no take attempt failures which happen out of the validityInterval into failure count|
| reservation-id| string | Represent the unique id of the corresponding reserved resource allocation in the scheduler |
Expand All @@ -3201,7 +3201,7 @@ The am-container-spec object should be used to provide the container launch cont
| local-resources | object | Object describing the resources that need to be localized, described below |
| environment | object | Environment variables for your containers, specified as key value pairs |
| commands | object | The commands for launching your container, in the order in which they should be executed |
| service-data | object | Application specific service data; key is the name of the auxiliary servce, value is base-64 encoding of the data you wish to pass |
| service-data | object | Application specific service data; key is the name of the auxiliary service, value is base-64 encoding of the data you wish to pass |
| credentials | object | The credentials required for your application to run, described below |
| application-acls | objec | ACLs for your application; the key can be "VIEW\_APP" or "MODIFY\_APP", the value is the list of users with the permissions |

Expand Down Expand Up @@ -3237,8 +3237,8 @@ Elements of the POST request body *log-aggregation-context* object

| Item | Data Type | Description |
|:---- |:---- |:---- |
| log-include-pattern | string | The log files which match the defined include pattern will be uploaded when the applicaiton finishes |
| log-exclude-pattern | string | The log files which match the defined exclude pattern will not be uploaded when the applicaiton finishes |
| log-include-pattern | string | The log files which match the defined include pattern will be uploaded when the application finishes |
| log-exclude-pattern | string | The log files which match the defined exclude pattern will not be uploaded when the application finishes |
| rolled-log-include-pattern | string | The log files which match the defined include pattern will be aggregated in a rolling fashion |
| rolled-log-exclude-pattern | string | The log files which match the defined exclude pattern will not be aggregated in a rolling fashion |
| log-aggregation-policy-class-name | string | The policy which will be used by NodeManager to aggregate the logs |
Expand Down Expand Up @@ -3466,7 +3466,7 @@ Response Body:
Cluster Application State API
-----------------------------

With the application state API, you can query the state of a submitted app as well kill a running app by modifying the state of a running app using a PUT request with the state set to "KILLED". To perform the PUT operation, authentication has to be setup for the RM web services. In addition, you must be authorized to kill the app. Currently you can only change the state to "KILLED"; an attempt to change the state to any other results in a 400 error response. Examples of the unauthorized and bad request errors are below. When you carry out a successful PUT, the iniital response may be a 202. You can confirm that the app is killed by repeating the PUT request until you get a 200, querying the state using the GET method or querying for app information and checking the state. In the examples below, we repeat the PUT request and get a 200 response.
With the application state API, you can query the state of a submitted app as well kill a running app by modifying the state of a running app using a PUT request with the state set to "KILLED". To perform the PUT operation, authentication has to be setup for the RM web services. In addition, you must be authorized to kill the app. Currently you can only change the state to "KILLED"; an attempt to change the state to any other results in a 400 error response. Examples of the unauthorized and bad request errors are below. When you carry out a successful PUT, the initial response may be a 202. You can confirm that the app is killed by repeating the PUT request until you get a 200, querying the state using the GET method or querying for app information and checking the state. In the examples below, we repeat the PUT request and get a 200 response.

Please note that in order to kill an app, you must have an authentication filter setup for the HTTP interface. The functionality requires that a username is set in the HttpServletRequest. If no filter is setup, the response will be an "UNAUTHORIZED" response.

Expand Down Expand Up @@ -3645,7 +3645,7 @@ Request Body:

Response Header:

HTTP/1.1 403 Unauthorized
HTTP/1.1 401 Unauthorized
Server: Jetty(6.1.26)

**Bad Request Error Response**
Expand Down Expand Up @@ -4454,7 +4454,7 @@ Elements of the *reservation-request* object

| Item | Data Type | Description |
|:---- |:---- |:---- |
| duration | long | The duration of a ReservationRequeust in milliseconds (amount of consecutive milliseconds a satisfiable allocation for this portion of the reservation should exist for). |
| duration | long | The duration of a ReservationRequest in milliseconds (amount of consecutive milliseconds a satisfiable allocation for this portion of the reservation should exist for). |
| num-containers | int | The number of containers required in this phase of the reservation (capture the maximum parallelism of the job(s) in this phase). |
| min-concurrency | int | The minimum number of containers that must be concurrently allocated to satisfy this allocation (capture min-parallelism, useful to express gang semantics). |
| capability | object | Allows to specify the size of each container (memory, vCores).|
Expand Down Expand Up @@ -4630,7 +4630,7 @@ Elements of the *reservation-request* object

| Item | Data Type | Description |
|:---- |:---- |:---- |
| duration | long | The duration of a ReservationRequeust in milliseconds (amount of consecutive milliseconds a satisfiable allocation for this portion of the reservation should exist for). |
| duration | long | The duration of a ReservationRequest in milliseconds (amount of consecutive milliseconds a satisfiable allocation for this portion of the reservation should exist for). |
| num-containers | int | The number of containers required in this phase of the reservation (capture the maximum parallelism of the job(s) in this phase). |
| min-concurrency | int | The minimum number of containers that must be concurrently allocated to satisfy this allocation (capture min-parallelism, useful to express gang semantics). |
| capability | object | Allows to specify the size of each container (memory, vCores).|
Expand Down