List Cluster Hosts | vRealize Automation Container Service API

List Cluster Hosts

Retrieves all hosts for a given cluster. Operation is available for container admins, system admins and container developers.

Request

URI

GET

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

COPY

Path Parameters

string

Required

The id of cluster which hosts need to be retrieved.

Query Parameters

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

Responses

200

successful operation.

Returns PageComputeState of type(s) */*

{
    "number": 0,
    "numberOfElements": 0,
    "last": false,
    "size": 0,
    "totalPages": 0,
    "first": false,
    "content": [
        {
            "hostName": "string",
            "powerState": "string",
            "environmentName": "string",
            "tagLinks": [
                "string"
            ],
            "creationTimeMicros": 0,
            "zoneId": "string",
            "groupLinks": [
                "string"
            ],
            "id": "string",
            "gpuCount": 0,
            "cpuCount": 0,
            "lifecycleState": "string",
            "documentExpirationTimeMicros": "string",
            "parentLink": "string",
            "address": "string",
            "diskLinks": [
                "string"
            ],
            "endpointLink": "string",
            "instanceType": "string",
            "descriptionLink": "string",
            "cpuMhzPerCore": 0,
            "documentUpdateTimeMicros": "string",
            "primaryMAC": "string",
            "totalMemoryBytes": 0,
            "resourcePoolLink": "string",
            "adapterManagementReference": "string",
            "regionId": "string",
            "networkInterfaceLinks": [
                "string"
            ],
            "documentSelfLink": "string",
            "name": "string",
            "tenantLinks": [
                "string"
            ],
            "desc": "string"
        }
    ],
    "totalElements": 0
}

integer As int32 As int32

number

Optional

number

integer As int32 As int32

numberOfElements

Optional

numberOfElements

boolean

last

Optional

last