This is an automated email from the ASF dual-hosted git repository.
chenyulin0719 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 788a6b2c4f [YUNIKORN-2969] fix inconsistent layout in REST
documentation (#510)
788a6b2c4f is described below
commit 788a6b2c4fa1ee424d9b56bc08fb2e175adfb4dd
Author: Ryan <[email protected]>
AuthorDate: Sat Jan 4 14:47:41 2025 +0800
[YUNIKORN-2969] fix inconsistent layout in REST documentation (#510)
Closes: #510
Signed-off-by: Yu-Lin Chen <[email protected]>
---
docs/api/scheduler.md | 111 +++++++++++++++++++++++++-------------------------
1 file changed, 56 insertions(+), 55 deletions(-)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index f76880c926..91087ad644 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -1,6 +1,7 @@
---
id: scheduler
title: Scheduler
+toc_max_heading_level: 4
---
<!--
@@ -43,7 +44,7 @@ Returns general information and statistics about a partition.
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -127,7 +128,7 @@ Returns general information and statistics about a
partition.
]
```
-### Error response
+#### Error response
**Code** : `500 Internal Server Error`
@@ -142,7 +143,7 @@ This list can be different from the list in the
configuration.
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -165,7 +166,7 @@ This list can be different from the list in the
configuration.
]
```
-### Error responses
+#### Error responses
**Code** : `400 Bad Request` (URL query is invalid, missing partition name)
@@ -186,7 +187,7 @@ The queues' hierarchy is kept in the response json.
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -287,7 +288,7 @@ For the default queue hierarchy (only `root.default` leaf
queue exists) a simila
]
```
-### Error response
+#### Error response
**Code** : `400 Bad Request` (URL query is invalid, missing partition name)
@@ -312,7 +313,7 @@ If the query parameter `subtree` is not set, the queue's
children will not be re
**URL query parameters** :
- `subtree` (optional) : When `subtree` is set (it can be any value, e.g.,
`true`), the queue's children will be returned.
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -358,7 +359,7 @@ If the query parameter `subtree` is not set, the queue's
children will not be re
}
```
-### Error response
+#### Error response
**Code** : `400 Bad Request` (URL query is invalid)
@@ -381,7 +382,7 @@ For active state, can narrow the result by status query
parameters(case-insensit
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -390,7 +391,7 @@ For active state, can narrow the result by status query
parameters(case-insensit
The content of the application object is the same as Queue Applications. See
[Queue Applications](#queue-applications) for details.
-### Error Response
+#### Error Response
**Code** : `400 Bad Request` (URL query is invalid)
@@ -408,7 +409,7 @@ Fetch all Applications for the given Partition/Queue
combination and displays ge
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -636,7 +637,7 @@ In the example below there are three allocations belonging
to two applications,
]
```
-### Error response
+#### Error response
**Code** : `400 Bad Request` (URL query is invalid)
@@ -667,7 +668,7 @@ The state parameter must be set to "active", which is not
an actual application
Note: If the queue name contains any special characters, it needs to be URL
escaped to avoid issues.
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -675,7 +676,7 @@ Note: If the queue name contains any special characters, it
needs to be URL esca
The content of the application object is the same as Queue Applications. See
[Queue Applications](#queue-applications) for details.
-### Error response
+#### Error response
**Code** : `400 Bad Request` (URL query is invalid)
@@ -695,7 +696,7 @@ Fetch an Application given a Partition, Queue(optional) and
Application ID and d
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -827,7 +828,7 @@ Field `uuid` has been deprecated, would be removed from
below response in YUNIKO
}
```
-### Error response
+#### Error response
**Code** : `400 Bad Request` (URL query is invalid)
@@ -836,10 +837,10 @@ Field `uuid` has been deprecated, would be removed from
below response in YUNIKO
**Code** : `500 Internal Server Error`
-## UsersTracker
-### Get users usage tracking information
+## User quota and usage
+### All users
-Fetch all users usage given a Partition and displays general information about
the users managed by YuniKorn.
+Fetch all users given a Partition and displays usage and quota information for
the users. All queues in the hierarchy tracked for the specific user will be
included.
**URL** : `/ws/v1/partition/{partitionName}/usage/users`
@@ -847,7 +848,7 @@ Fetch all users usage given a Partition and displays
general information about t
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -930,13 +931,13 @@ Fetch all users usage given a Partition and displays
general information about t
]
```
-### Error response
+#### Error response
**Code** : `500 Internal Server Error`
-## UserTracker
-### Get specific user usage tracking information
-Fetch specific user usage given a Partition and displays general information
about the users managed by YuniKorn. In case the username contains any special
characters, it needs to be url escaped to avoid issues.
+### Single user
+
+Fetch the specified user given a Partition and displays usage and quota
information for the user. All queues in the hierarchy tracking the user will be
included.
**URL** : `/ws/v1/partition/{partitionName}/usage/user/{userName}`
@@ -944,7 +945,7 @@ Fetch specific user usage given a Partition and displays
general information abo
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -989,7 +990,7 @@ Fetch specific user usage given a Partition and displays
general information abo
}
```
-### Error response
+#### Error response
**Code** : `400 Bad Request` (URL query is invalid)
@@ -997,9 +998,10 @@ Fetch specific user usage given a Partition and displays
general information abo
**Code** : `500 Internal Server Error`
-## GroupsTracker
-### Get groups usage tracking information
-Fetch all groups usage given a Partition and displays general information
about the groups managed by YuniKorn.
+## Group quota and usage
+### All groups
+
+Fetch all groups usage given a Partition and displays usage and quota
information for the groups. All queues in the hierarchy tracked for the
specific groups will be included.
**URL** : `/ws/v1/partition/{partitionName}/usage/groups`
@@ -1007,7 +1009,7 @@ Fetch all groups usage given a Partition and displays
general information about
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -1086,14 +1088,13 @@ Fetch all groups usage given a Partition and displays
general information about
]
```
-### Error response
+#### Error response
**Code** : `500 Internal Server Error`
-## GroupTracker
-### Get specific group usage tracking information
+### Single group
-Fetch specific group usage given a Partition and displays general information
about the groups managed by YuniKorn. In case the group name contains any
special characters, it needs to be url escaped to avoid issues.
+Fetch the specified group given a Partition and displays usage and quota
information for the group. All queues in the hierarchy tracking the group will
be included.
**URL** : `/ws/v1/partition/{partitionName}/usage/group/{groupName}`
@@ -1101,7 +1102,7 @@ Fetch specific group usage given a Partition and displays
general information ab
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -1144,7 +1145,7 @@ Fetch specific group usage given a Partition and displays
general information ab
}
```
-### Error response
+#### Error response
**Code** : `400 Bad Request` (URL query is invalid)
@@ -1165,7 +1166,7 @@ Node details include host and rack name, capacity,
resources, utilization, and a
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -1354,7 +1355,7 @@ Here you can see an example response from a 2-node
cluster having 3 allocations.
]
```
-### Error response
+#### Error response
**Code** : `400 Bad Request` (URL query is invalid)
@@ -1375,7 +1376,7 @@ Node details include host and rack name, capacity,
resources, utilization, and a
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -1470,7 +1471,7 @@ Node details include host and rack name, capacity,
resources, utilization, and a
}
```
-### Error response
+#### Error response
**Code** : `400 Bad Request` (URL query is invalid)
@@ -1478,7 +1479,7 @@ Node details include host and rack name, capacity,
resources, utilization, and a
**Code** : `500 Internal Server Error`
-## Node utilization
+### Node utilization
Show how every node is distributed with regard to dominant resource
utilization.
@@ -1490,7 +1491,7 @@ Show how every node is distributed with regard to
dominant resource utilization.
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -1520,12 +1521,12 @@ Show how every node is distributed with regard to
dominant resource utilization.
}
```
-### Error response
+#### Error response
**Code** : `500 Internal Server Error`
-## Node utilizations
+### Node utilizations
Show the nodes utilization of different types of resources in a cluster.
@@ -1535,7 +1536,7 @@ Show the nodes utilization of different types of
resources in a cluster.
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -1587,7 +1588,7 @@ Show the nodes utilization of different types of
resources in a cluster.
]
```
-### Error response
+#### Error response
**Code** : `500 Internal Server Error`
@@ -1601,7 +1602,7 @@ Endpoint to retrieve historical data about the number of
total applications by t
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -1632,7 +1633,7 @@ Endpoint to retrieve historical data about the number of
total applications by t
]
```
-### Error response
+#### Error response
**Code** : `500 Internal Server Error`
@@ -1646,7 +1647,7 @@ Endpoint to retrieve historical data about the number of
total containers by tim
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -1677,7 +1678,7 @@ Endpoint to retrieve historical data about the number of
total containers by tim
]
```
-### Error response
+#### Error response
**Code** : `500 Internal Server Error`
@@ -1691,7 +1692,7 @@ Endpoint to retrieve historical data about critical logs,
negative resource on n
**Auth required** : NO
-### Success response
+#### Success response
**Code** : `200 OK`
@@ -1774,7 +1775,7 @@ Endpoint is used to retrieve a batch of event records.
- `start` (optional) : Specifies the starting ID for retrieving events. If the
specified ID is outside the ring buffer
(too low or too high), the response will include the lowest and highest ID
values with `EventRecords` being empty.
-### Success response
+#### Success response
**Code**: `200 OK`
@@ -1824,7 +1825,7 @@ Endpoint is used to retrieve a batch of event records.
}
```
-### Error response
+#### Error response
**Code** : `500 Internal Server Error`
@@ -1842,7 +1843,7 @@ The number of active connections is limited. The default
setting is 100 connecti
**URL query parameters**:
- `count` (optional) : Specifies the number of past events (those which have
been generated before the connection establishment) to include in the response.
Default value is 0.
-### Success response
+#### Success response
**Code**: `200 OK`
@@ -1934,7 +1935,7 @@ Allocation (603) added (2) to user resource usage (5):
}
```
-### Error responses
+#### Error responses
**Code** : `400 Bad Request` (URL query is invalid)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
