This is an automated email from the ASF dual-hosted git repository.
chia7712 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 1d3e682dca [YUNIKORN-2194] docs: add
`/ws/v1/scheduler/node-utilization` endpoint doc (#372)
1d3e682dca is described below
commit 1d3e682dca448465b967bc044615df3258bcec5c
Author: Cliff Su <[email protected]>
AuthorDate: Thu Jan 11 22:50:48 2024 +0800
[YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc
(#372)
Closes: #372
Signed-off-by: Chia-Ping Tsai <[email protected]>
---
docs/api/scheduler.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 54 insertions(+)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index 14203fb0dd..a9db4cce26 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -1378,6 +1378,60 @@ Node details include host and rack name, capacity,
resources, utilization, and a
}
```
+## Node utilization
+
+Show how every node is distributed with regard to dominant resource
utilization.
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```text
+{
+ "type": "vcore",
+ "utilization": [
+ {
+ "bucketName": "0-10%",
+ "numOfNodes": 1,
+ "nodeNames": [
+ "aethergpu"
+ ]
+ },
+ {
+ "bucketName": "10-20%",
+ "numOfNodes": 2,
+ "nodeNames": [
+ "primary-node",
+ "second-node"
+ ]
+ },
+ ...
+ ]
+}
+```
+
+### Error response
+
+**Code** : `500 Internal Server Error`
+
+**Content examples**
+
+```json
+{
+ "status_code": 500,
+ "message": "system error message. for example, json: invalid UTF-8 in
string: ..",
+ "description": "system error message. for example, json: invalid UTF-8 in
string: .."
+}
+```
+
## Goroutines info
Dumps the stack traces of the currently running goroutines.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
