Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[YUNIKORN-2217] Add Missing REST Endpoint description for batch event in documentation #379

Closed
wants to merge 2 commits into from
Closed

[YUNIKORN-2217] Add Missing REST Endpoint description for batch event in documentation #379

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cefb67
[YUNIKORN-2217] Add Missing REST Endpoint description for batch event…
Haser0305 Dec 6, 2023
2e6b708
add the URL query parameters.
Haser0305 Jan 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions docs/api/scheduler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1895,3 +1895,74 @@ None
### Error response

**Code**: `400 Bad Request`


## Batch Events

Endpoint is used to retrieve a batch of event records.

**URL**: `/ws/v1/events/batch`

**METHOD** : `GET`

**Auth required** : NO

**URL query parameters** :
- `count` (optional) : Specifies the maxmem number of events to be included in the response.
- `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

**Code**: `200 OK`

**Content examples**

```json
{
"InstanceUUID": "400046c6-2180-41a2-9be1-1c251ab2c498",
"LowestID": 0,
"HighestID": 7,
"EventRecords": [
{
"type": 3,
"objectID": "yk8s-worker",
"message": "schedulable: true",
"timestampNano": 1701347180239597300,
"eventChangeType": 1,
"eventChangeDetail": 302,
"resource": {}
},
{
"type": 3,
"objectID": "yk8s-worker",
"message": "Node added to the scheduler",
"timestampNano": 1701347180239650600,
"eventChangeType": 2,
"resource": {
"resources": {
"ephemeral-storage": {
"value": 502921060352
},
"hugepages-1Gi": {},
"hugepages-2Mi": {},
"memory": {
"value": 33424998400
},
"pods": {
"value": 110
},
"vcore": {
"value": 8000
}
}
}
}
]
}
```

### Error response

**Code** : `500 Internal Server Error`
Loading