List All Clusters | vRealize Automation Container Service API

List All Clusters

Retrieves all clusters. Operation is available for container admins, system admins and container developers.

Request

URI

GET

https://{api_host}/container-service/api/resources/clusters

COPY

Query Parameters

string

Optional

integer

page

Optional

Page Number

integer

limit

Optional

Number of entries per page

string

$orderby

Optional

Multiple comma-separated properties sorted in ascending or descending order

integer

$top

Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer

$skip

Optional

Sets how many entries you would like to skip

string

$filter

Optional

Boolean expression for whether a particular entry should be included in the response

Header Parameters

string

x-project

Optional

x-project

Responses

200

successful operation. Response body contains the list of retrieved clusters

Returns PageClusterDto of type(s) */*

{
    "number": 0,
    "numberOfElements": 0,
    "last": false,
    "size": 0,
    "totalPages": 0,
    "first": false,
    "content": [
        {
            "cpuUsage": "number",
            "documentExpirationTimeMicros": "string",
            "address": "string",
            "memoryUsage": 0,
            "nodeLinks": [
                "string"
            ],
            "systemContainersCount": 0,
            "publicAddress": "string",
            "type": "string",
            "documentUpdateTimeMicros": "string",
            "totalMemory": 0,
            "totalCpu": "number",
            "documentSelfLink": "string",
            "clusterCreationTimeMicros": 0,
            "name": "string",
            "details": "string",
            "tenantLinks": [
                "string"
            ],
            "containerCount": 0,
            "status": "string"
        }
    ],
    "totalElements": 0
}

integer As int32 As int32

number

Optional

number

integer As int32 As int32

numberOfElements

Optional

numberOfElements

boolean

last

Optional

last