Get Root Resource Pools

Get a list of all root resource pools that are eligible for consumption. If a resource pool is ineligible but is in the response, this means it has children which are eligible for consumption. A resource pool will be ineligible, unless the cluster has an ESXi host on it. The list will be sorted by name, case insensitive.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/virtualCenters/{vcUrn}/resourcePools/browse

COPY

Path Parameters

string

vcUrn

Required

vcUrn

Query Parameters

integer

page

Required

Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer

pageSize

Required

Constraints: minimum: 0 maximum: 64 default: 25

Results per page to fetch.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns ResourcePools of type(s) application/json;version=39.1

This response body class contains all of the following: InlineResourcePools0 , InlineResourcePools1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "moref": "string",
            "clusterMoref": "string",
            "name": "string",
            "vcId": "string",
            "eligible": false,
            "kubernetesEnabled": false,
            "vgpuEnabled": false
        }
    ]
}

400

Invalid configuration.

Returns Error of type(s) application/json;version=39.1

"Error Object"

string

minorErrorCode

Required

minorErrorCode

string

message

Required

message

string

stackTrace

Optional

stackTrace

404

The specified resource was not found

Returns Error of type(s) application/json;version=39.1

"Error Object"

string

minorErrorCode

Required

minorErrorCode

string

message

Required

message

string

stackTrace

Optional

stackTrace

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/virtualCenters/{vcUrn}/resourcePools/browse?page=value&pageSize=v

Availability

Added in 33.0

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Virtual Center Operations