This is an automated email from the ASF dual-hosted git repository.
pbacsko pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new dba3ad198a [YUNIKORN-2581] Add placement rule REST call to
documentation (#433)
dba3ad198a is described below
commit dba3ad198a319120f6149592d37d8b4208fcab8b
Author: Wilfred Spiegelenburg <[email protected]>
AuthorDate: Fri May 31 14:47:43 2024 +0200
[YUNIKORN-2581] Add placement rule REST call to documentation (#433)
Side fix: add event streaming overview data to the state dump details
Closes: #433
Signed-off-by: Peter Bacsko <[email protected]>
---
docs/api/scheduler.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 44 insertions(+)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index 2c0f2c98c4..482b98dfb2 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -141,6 +141,48 @@ Returns general information and statistics about a
partition.
}
```
+## PlacementRules
+
+Returns the list of currently active placement rules for the partition.
+This list can be different from the list in the configuration.
+
+**URL** : `/ws/v1/partition/{partitionName}/placementrules`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```json
+[
+ {
+ "name": "provided",
+ "parameters": {
+ "create":"false"
+ }
+ },
+ {
+ "name":"recovery",
+ "parameters": {
+ "queue": "root.@recovery@"
+ }
+ }
+]
+```
+
+### Error responses
+
+**Code** : `400 Bad Request` (URL query is invalid, missing partition name)
+
+**Code** : `404 Not Found` (Partition not found)
+
+**Code** : `500 Internal Server Error`
+
## Queues
### Partition queues
@@ -2009,6 +2051,8 @@ Endpoint to retrieve the following information in a
single response:
* RMDiagnostics
* Log level
* Configuration
+* Placement rules
+* Event stream overview (client hostname and creation timestamp)
**URL** : `/ws/v1/fullstatedump`
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
