Vcenter ResourcePool list

Vcenter ResourcePool list

Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the Vcenter ResourcePool FilterSpec.

Request
URI
GET
https://{api_host}/api/vcenter/resource-pool
COPY
Query Parameters
string of array
resource_pools
Optional

Identifiers of resource pools that can match the filter.

If missing or null or empty, resource pools with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ResourcePool.

string of array
names
Optional

Names that resource pools must have to match the filter (see Vcenter ResourcePool Info.name).

If missing or null or empty, resource pools with any name match the filter.

string of array
parent_resource_pools
Optional

Resource pools that must contain the resource pool for the resource pool to match the filter.

If missing or null or empty, resource pools in any resource pool match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ResourcePool.

string of array
datacenters
Optional

Datacenters that must contain the resource pool for the resource pool to match the filter.

If missing or null or empty, resource pools in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.

string of array
hosts
Optional

Hosts that must contain the resource pool for the resource pool to match the filter.

If missing or null or empty, resource pools in any host match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

string of array
clusters
Optional

Clusters that must contain the resource pool for the resource pool to match the filter.

If missing or null or empty, resource pools in any cluster match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.

Authentication
This operation uses the following authentication methods.
Responses
200

Commonly used information about the resource pools matching the Vcenter ResourcePool FilterSpec.

[
    {
        "resource_pool": "string",
        "name": "string"
    }
]
array of Vcenter ResourcePool Summary
Optional

401

If the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

If the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

500

If more than 1000 resource pools match the Vcenter ResourcePool FilterSpec.

Returns Vapi Std Errors UnableToAllocateResource of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors UnableToAllocateResource0 
"Vapi Std Errors UnableToAllocateResource Object"

503

If the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/resource-pool
On This Page
Vcenter Operations
GET
Vcenter ResourcePool get
DELETE
Vcenter ResourcePool delete
PATCH
Vcenter ResourcePool update
GET
Vcenter ResourcePool list
POST
Vcenter ResourcePool create