wilfred-s commented on a change in pull request #93:
URL:
https://github.com/apache/incubator-yunikorn-site/pull/93#discussion_r750824414
##########
File path: docs/api/scheduler.md
##########
@@ -1249,4 +1249,68 @@ Endpoint to retrieve historical data about critical
logs, negative resource on n
}
]
}
-```
\ No newline at end of file
+```
+
+## Retrieve full state dump
+
+Endpoint to retrieve the following information in a single response:
+
+* List of partitions
+* List of applications (running and completed)
+* Application history
+* Nodes
+* Utilization of nodes
+* Generic cluster information
+* Cluster utilization
+* Container history
+* Queues
+
+**URL** : `/ws/v1/fullstatedump`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+The output of this REST query can be rather big and it is a combination of
those which have already been demonstrated.
+
+### Failure response
+
+**Code**: `500 Internal Server Error`
+
+## Enable or disable periodic state dump to an external file inside the
container which runs Yunikorn
+
+Endpoint to enable a state dump to be written periodically. By default, it is
60 seconds. The output goes to a file called `yunikorn-state.txt`. In the
current version, the file is located in the current working directory of
Yunikorn and it is not configurable.
+
+Trying to enable or disable this feature more than once in a row results in an
error.
+
+**URL** : `/ws/v1/periodicstatedump/{switch}/{period}`
+
+**Method** : `GET`
Review comment:
that is correct. The tests also use a GET requests which I logged as a
new jira
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
