Get Node Stats

JFrog REST APIs

Products

JFrog Xray

Content Type

REST API

ft:sourceType

Paligo

Description: Gets a a list of node stats.

Security: Requires a valid user

Usage: GET api/v1/nodeStats

Produces: application/json

Parameters:

Parameter	Data Type	Description	Required/Optional
`nodeIds`	String	A filter on the list based on the nodeId property of the nodeStat. Expects a comma separated string of nodeIds.	Required
`limit`	Integer	A limit on the number of nodeStats returned.	Optional
`skip`	Integer	A cursor for use in pagination. This parameter defines the number of nodeStats skipped.	Optional
`reportedBefore`	String	A filter on the list that returns stats that have `reportedAt` property less than `reportedBefore`. Format: date-time	Optional
`reportedAfter`	String	A filter on the list that returns stats that have `reportedAt` property greater than `reportedAfter`. Format: date-time	Optional
`sortBy`	String	The nodeStat properties to sort the results by. Expects a comma separated list of sorters.	Optional
`sortOrder`	Integer	A sort order based on the `sortBy` defined. If '1', sorts the list in ascending order. If '-1', sorts the list in descending order.	Optional

Sample Request

curl -X GET 'https://mypipelines.io/pipelines/api/v1/nodeStats?nodeIds=2923995'

Sample Response:

[
    {
        "id": 356045599,
        "nodeId": 2925082,
        "reportedAt": "2023-06-05T09:47:17.005Z",
        "diskUsageInPercentage": "24",
        "memoryUsageInPercentage": "14",
        "cpuLoadInPercentage": "43",
        "activeContainersCount": 0,
        "totalContainersCount": 0,
        "imageCount": 8,
        "projectId": 7,
        "createdBy": null,
        "updatedBy": null,
        "createdAt": "2023-06-05T09:47:17.039Z",
        "updatedAt": "2023-06-05T09:47:17.039Z"
    }
]

Response Codes:

200: Success