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 de84775890 [YUNIKORN-2461] Consider supporting
/ws/v1/partition/{partitionName}/queue/{queueName}/applications/:state (#463)
de84775890 is described below
commit de847758900323f6f030bac7087537ebd7e7fbfc
Author: Tzu-Hua Lan <[email protected]>
AuthorDate: Mon Aug 19 03:13:28 2024 +0800
[YUNIKORN-2461] Consider supporting
/ws/v1/partition/{partitionName}/queue/{queueName}/applications/:state (#463)
Closes: #463
Signed-off-by: Chia-Ping Tsai <[email protected]>
---
docs/api/scheduler.md | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index e1e7a92cff..e5943360e6 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -646,6 +646,44 @@ In the example below there are three allocations belonging
to two applications,
**Code** : `500 Internal Server Error`
+### Queue applications by state
+
+Fetch all Applications for the given Partition/Queue/State combination and
displays general information about the applications like used resources, queue
name, submission time and allocations.
+
+The state parameter must be set to "active", which is not an actual
application state but a virtual state used for this API call. This fake state
represents the following application states: New, Accepted, Running,
Completing, Failing, and Resuming. You can further narrow down the results
using the optional status query parameter to filter for specific real states.
+
+**URL** : `/ws/v1/partition/:partition/queue/:queue/applications/:state`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+**URL query parameters** :
+- `status` (optional) : Filters active applications by their specific real
state (New, Accepted, Running, Completing, Failing, Resuming)
+
+**Example requests**:
+- Fetch active applications in the default partition and root queue:
+ `/ws/v1/partition/default/queue/root/applications/active`
+- Fetch only running applications in the default partition and root queue:
+ `/ws/v1/partition/default/queue/root/applications/active?status=running`
+
+Note: If the queue name contains any special characters, it needs to be URL
escaped to avoid issues.
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+The content of the application object is the same as Queue Applications. See
[Queue Applications](#queue-applications) for details.
+
+### Error response
+
+**Code** : `400 Bad Request` (URL query is invalid)
+
+**Code** : `404 Not Found` (Partition or Queue not found)
+
+**Code** : `500 Internal Server Error`
## Application
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
