You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by yu...@apache.org on 2023/05/11 11:42:18 UTC
[yunikorn-site] branch master updated: [YUNIKORN-1383] REST API doc changes in Yunikorn Website (#289)
This is an automated email from the ASF dual-hosted git repository.
yuteng 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 a897a4c43 [YUNIKORN-1383] REST API doc changes in Yunikorn Website (#289)
a897a4c43 is described below
commit a897a4c439572f87051c3ca86cdde5f5ad3bf95d
Author: Qi Zhu <82...@qq.com>
AuthorDate: Thu May 11 19:42:13 2023 +0800
[YUNIKORN-1383] REST API doc changes in Yunikorn Website (#289)
* [YUNIKORN-1383] [website] REST API doc changes in Yunikorn Website
* Address new comments.
---
docs/api/scheduler.md | 347 ++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 347 insertions(+)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index 05f8fbf5a..85a45713a 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -681,6 +681,353 @@ Fetch an Application given a Partition, Queue and Application ID and displays ge
}
```
+## UsersTracker
+### Get users usage tracking information
+
+Fetch all users usage given a Partition and displays general information about the users managed by YuniKorn.
+
+**URL** : `/ws/v1/partition/{partitionName}/usage/users`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```json
+[
+ {
+ "userName": "user1",
+ "groups": {
+ "app2": "tester"
+ },
+ "queues":
+ {
+ "queuePath": "root",
+ "resourceUsage": {
+ "memory": 12000000000,
+ "vcore": 12000
+ },
+ "runningApplications": ["app1", "app2"],
+ "children": [
+ {
+ "queuePath": "root.default",
+ "resourceUsage": {
+ "memory": 6000000000,
+ "vcore": 6000
+ },
+ "runningApplications": ["app1"],
+ "children": []
+ },
+ {
+ "queuePath": "root.test",
+ "resourceUsage": {
+ "memory": 6000000000,
+ "vcore": 6000
+ },
+ "runningApplications": [
+ "app2"
+ ],
+ "children": []
+ }]
+ }
+ },
+ {
+ "userName": "user2",
+ "groups": {
+ "app1": "tester"
+ },
+ "queues":
+ {
+ "queuePath": "root",
+ "resourceUsage": {
+ "memory": 11000000000,
+ "vcore": 10000
+ },
+ "runningApplications": ["app1", "app2", "app3"],
+ "children": [
+ {
+ "queuePath": "root.default",
+ "resourceUsage": {
+ "memory": 5000000000,
+ "vcore": 5000
+ },
+ "runningApplications": ["app1"],
+ "children": []
+ },
+ {
+ "queuePath": "root.test",
+ "resourceUsage": {
+ "memory": 4000000000,
+ "vcore": 4000
+ },
+ "runningApplications": [
+ "app3"
+ ],
+ "children": []
+ }]
+ }
+ }
+]
+```
+
+### 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: .."
+}
+```
+
+## UserTracker
+### Get specific user usage tracking information
+Fetch specific user usage given a Partition and displays general information about the users managed by YuniKorn.
+
+**URL** : `/ws/v1/partition/{partitionName}/usage/user/{userName}`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```json
+{
+ "userName": "user1",
+ "groups": {
+ "app1": "tester"
+ },
+ "queues":
+ {
+ "queuePath": "root",
+ "resourceUsage": {
+ "memory": 12000000000,
+ "vcore": 12000
+ },
+ "runningApplications": ["app1", "app2"],
+ "children": [
+ {
+ "queuePath": "root.default",
+ "resourceUsage": {
+ "memory": 6000000000,
+ "vcore": 6000
+ },
+ "runningApplications": ["app1"],
+ "children": []
+ },
+ {
+ "queuePath": "root.test",
+ "resourceUsage": {
+ "memory": 6000000000,
+ "vcore": 6000
+ },
+ "runningApplications": [
+ "app2"
+ ],
+ "children": []
+ }]
+ }
+}
+```
+
+### 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: .."
+}
+```
+
+## GroupsTracker
+### Get groups usage tracking information
+Fetch all groups usage given a Partition and displays general information about the groups managed by YuniKorn.
+
+**URL** : `/ws/v1/partition/{partitionName}/usage/groups`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```json
+[
+ {
+ "groupName": "group1",
+ "applications": ["app1", "app2"],
+ "queues":
+ {
+ "queuePath": "root",
+ "resourceUsage": {
+ "memory": 12000000000,
+ "vcore": 12000
+ },
+ "runningApplications": ["app1", "app2"],
+ "children": [
+ {
+ "queuePath": "root.default",
+ "resourceUsage": {
+ "memory": 6000000000,
+ "vcore": 6000
+ },
+ "runningApplications": ["app1"],
+ "children": []
+ },
+ {
+ "queuePath": "root.test",
+ "resourceUsage": {
+ "memory": 6000000000,
+ "vcore": 6000
+ },
+ "runningApplications": [
+ "app2"
+ ],
+ "children": []
+ }]
+ }
+ },
+ {
+ "groupName": "group2",
+ "applications": ["app1", "app2", "app3"],
+ "queues":
+ {
+ "queuePath": "root",
+ "resourceUsage": {
+ "memory": 11000000000,
+ "vcore": 10000
+ },
+ "runningApplications": ["app1", "app2", "app3"],
+ "children": [
+ {
+ "queuePath": "root.default",
+ "resourceUsage": {
+ "memory": 5000000000,
+ "vcore": 5000
+ },
+ "runningApplications": ["app1"],
+ "children": []
+ },
+ {
+ "queuePath": "root.test",
+ "resourceUsage": {
+ "memory": 4000000000,
+ "vcore": 4000
+ },
+ "runningApplications": [
+ "app3"
+ ],
+ "children": []
+ }]
+ }
+ }
+]
+```
+
+### 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: .."
+}
+```
+
+## GroupTracker
+### Get specific group usage tracking information
+
+Fetch specific group usage given a Partition and displays general information about the groups managed by YuniKorn.
+
+**URL** : `/ws/v1/partition/{partitionName}/usage/group/{groupName}`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```json
+{
+ "groupName": "group1",
+ "applications": ["app1", "app2"],
+ "queues":
+ {
+ "queuePath": "root",
+ "resourceUsage": {
+ "memory": 12000000000,
+ "vcore": 12000
+ },
+ "runningApplications": ["app1", "app2"],
+ "children": [
+ {
+ "queuePath": "root.default",
+ "resourceUsage": {
+ "memory": 6000000000,
+ "vcore": 6000
+ },
+ "runningApplications": ["app1"],
+ "children": []
+ },
+ {
+ "queuePath": "root.test",
+ "resourceUsage": {
+ "memory": 6000000000,
+ "vcore": 6000
+ },
+ "runningApplications": [
+ "app2"
+ ],
+ "children": []
+ }]
+ }
+}
+```
+
+### 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: .."
+}
+```
+
## Nodes
### Partition nodes