(yunikorn-site) branch master updated: [YUNIKORN-2763] add the documentation of REST API for specific queue (#458)

[ch...@apache.org]

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 c2e3332c63 [YUNIKORN-2763] add the documentation of REST API for specific queue (#458)
c2e3332c63 is described below

commit c2e3332c639ea4be896d46dfe4ac8b6e54c35a66
Author: Tzu-Hua Lan <bl...@gmail.com>
AuthorDate: Sun Jul 21 13:28:19 2024 +0800

    [YUNIKORN-2763] add the documentation of REST API for specific queue (#458)
    
    Add API description for /ws/v1/partition/{partitionName}/queue/{queueName}.
    
    Closes: #458
    
    Signed-off-by: Yu-Lin Chen <ch...@apache.org>
---
 docs/api/scheduler.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)

diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index 0eb3b45157..e1e7a92cff 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -297,6 +297,77 @@ For the default queue hierarchy (only `root.default` leaf queue exists) a simila
 
 **Code** : `500 Internal Server Error` 
 
+## Queue
+
+### Partition queue
+
+Fetch a Queue associated with given Partition and displays general information about the queue like name, status, capacities and properties. 
+
+If the query parameter `subtree` is not set, the queue's children will not be returned.
+
+**URL** : `/ws/v1/partition/{partitionName}/queue/{queueName}`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+**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
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```json
+{
+    "queuename": "root.default",
+    "status": "Active",
+    "maxResource": {
+        "memory": 8000000000,
+        "vcore": 8000
+    },
+    "guaranteedResource": {
+        "memory": 54000000,
+        "vcore": 80
+    },
+    "allocatedResource": {
+        "memory": 54000000,
+        "vcore": 80
+    },
+    "pendingResource": {
+        "memory": 54000000,
+        "vcore": 80
+    },
+    "isLeaf": "true",
+    "isManaged": "false",
+    "properties": {
+        "application.sort.policy": "stateaware"
+    },
+    "parent": "root",
+    "template": null,
+    "absUsedCapacity": {
+        "memory": 1,
+        "vcore": 0
+    },
+    "maxRunningApps": 12,
+    "runningApps": 4,
+    "allocatingAcceptedApps": [
+        "app-1",
+        "app-2"
+    ]
+}
+```
+
+### Error response
+
+**Code** : `400 Bad Request` (URL query is invalid)
+
+**Code** : `404 Not Found` (Partition or Queue not found)
+
+**Code** : `500 Internal Server Error`
+
 ## Applications
 
 ### Partition applications


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@yunikorn.apache.org
For additional commands, e-mail: issues-help@yunikorn.apache.org