This is an automated email from the ASF dual-hosted git repository.
wwei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new 63875dd YUNIKORN-746: Simplify the REST API document (#64)
63875dd is described below
commit 63875dd4408523c8ca754b863e8fcec48a6a7f15
Author: manirajv06 <[email protected]>
AuthorDate: Mon Jul 19 11:05:23 2021 +0530
YUNIKORN-746: Simplify the REST API document (#64)
---
docs/api/scheduler.md | 32 +++++++++++++++++++-------------
1 file changed, 19 insertions(+), 13 deletions(-)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index 8bc5d22..5570428 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -88,9 +88,11 @@ Displays general information about the partition like name,
state, capacity, use
}
```
-## Queues (Newer Version)
+## Queues
-Displays general information about the queues like name, status, capacities
and properties.
+### Partition queues
+
+Fetch all Queues associated with given Partition and displays general
information about the queues like name, status, capacities and properties.
The queues' hierarchy is kept in the response json.
**URL** : `/ws/v1/partition/{partitionName}/queues`
@@ -162,9 +164,9 @@ For the default queue hierarchy (only `root.default` leaf
queue exists) a simila
}
```
-## Queues (Deprecated)
+### All Queues
-Displays general information about the queues like name, status, capacities
and properties.
+Fetch all Queues across different Partitions and displays general information
about the queues like name, status, capacities and properties.
The queues' hierarchy is kept in the response json.
**URL** : `/ws/v1/queues`
@@ -217,9 +219,11 @@ For the default queue hierarchy (only `root.default` leaf
queue exists) a simila
}
```
-## Applications (Newer Version)
+## Applications
+
+### Queue applications
-Displays general information about the applications like used resources, queue
name, submission time and allocations.
+Fetch all Applications for the given Partition Queue combination and displays
general information about the applications like used resources, queue name,
submission time and allocations.
**URL** : `/ws/v1/partition/{partitioName}/queue/{queueName}/applications`
@@ -319,9 +323,9 @@ In the example below there are three allocations belonging
to two applications.
}
```
-## Applications (Deprecated)
+### All applications
-Displays general information about the applications like used resources, queue
name, submission time and allocations.
+Fetch all Applications across different Partitions and displays general
information about the applications like used resources, queue name, submission
time and allocations.
**URL** : `/ws/v1/apps`
@@ -401,9 +405,11 @@ In the example below there are three allocations belonging
to two applications.
]
```
-## Nodes (Newer Version)
+## Nodes
+
+### Partition nodes
-Displays general information about the nodes managed by YuniKorn.
+Fetch all Nodes associated with given Partition and displays general
information about the nodes managed by YuniKorn.
Node details include host and rack name, capacity, resources and allocations.
**URL** : `/ws/v1/partition/{partitionName}/nodes`
@@ -508,9 +514,9 @@ Here you can see an example response from a 2-node cluster
having 3 allocations.
}
```
-## Nodes (Deprecated)
+### All nodes
-Displays general information about the nodes managed by YuniKorn.
+Fetch all Nodes acrosss different Partitions and displays general information
about the nodes managed by YuniKorn.
Node details include host and rack name, capacity, resources and allocations.
**URL** : `/ws/v1/nodes`
@@ -774,7 +780,7 @@ yunikorn_scheduler_vcore_nodes_usage{range="(90%,100%]"} 0
yunikorn_scheduler_vcore_nodes_usage{range="[0,10%]"} 0
```
-## Configuration validation (Deprecated)
+## Configuration validation
**URL** : `/ws/v1/validate-conf`
