Skip to content

Commit

Permalink
[YUNIKORN-2194] docs: add /ws/v1/scheduler/node-utilization endpoin…
Browse files Browse the repository at this point in the history
…t doc
  • Loading branch information
stu01509 committed Nov 27, 2023
1 parent 8e46df7 commit 80dd0b4
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions docs/api/scheduler.md
Original file line number Diff line number Diff line change
Expand Up @@ -1361,6 +1361,55 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```

## Nodes utilization

Shows how nodes are distributed with regarding the utilization

**URL** : `/ws/v1/scheduler/node-utilization`

**Method** : `GET`

**Auth required** : NO

**Code** : `200 OK`

**Content examples**

```text
{
"type": "vcore",
"utilization": [
{
"bucketName": "0-10%",
"numOfNodes": 1,
"nodeNames": [
"aethergpu"
]
},
{
"bucketName": "10-20%",
"numOfNodes": 3,
"nodeNames": null
},
...
]
}
```

### Error response

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

**Content examples**

```json
{
"status_code": 500,
"message": "system error message. for example, json: invalid UTF-8 in string: ..",
"description": "system error message. for example, json: invalid UTF-8 in string: .."
}
```

## Goroutines info

Dumps the stack traces of the currently running goroutines.
Expand Down

0 comments on commit 80dd0b4

Please sign in to comment.