This API has a deprecated equivalent from v7.0U1.
List Resource Pool
Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec.
Request
URLURL
https://{api_host}/api/vcenter/resource-pool
Query Parameters
Query Parameters
array of
string
clusters
Optional
Clusters that must contain the resource pool for the resource pool to match the filter. If unset or empty, resource pools in any cluster match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ClusterComputeResource.
array of
string
datacenters
Optional
Datacenters that must contain the resource pool for the resource pool to match the filter. If unset or empty, resource pools in any datacenter match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datacenter. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datacenter.
array of
string
hosts
Optional
Hosts that must contain the resource pool for the resource pool to match the filter. If unset or empty, resource pools in any host match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
array of
string
names
Optional
Names that resource pools must have to match the filter (see ResourcePool.Info.name). If unset or empty, resource pools with any name match the filter.
array of
string
parent_resource_pools
Optional
Resource pools that must contain the resource pool for the resource pool to match the filter. If unset or empty, resource pools in any resource pool match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ResourcePool. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ResourcePool.
array of
string
resource_pools
Optional
Identifiers of resource pools that can match the filter. If unset or empty, resource pools with any identifier match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ResourcePool. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ResourcePool.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
ResourcePoolSummary
of type application/json
Commonly used information about the resource pools matching the ResourcePool.FilterSpec.
[
{
"name": "string",
"resource_pool": "string"
}
]
string
name
Required
Name of the resource pool.
string
resource_pool
Required
Identifier of the resource pool. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ResourcePool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ResourcePool.
Errors
403
com.vmware.vapi.std.errors.unauthorized : If the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : If more than 1000 resource pools match the ResourcePool.FilterSpec.
503
com.vmware.vapi.std.errors.service_unavailable : If the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListResourcePool -ResourcePools "MyResourcePools" -Names "MyNames" -ParentResourcePools "MyParentResourcePools" -Datacenters "MyDatacenters" -Hosts "MyHosts" -Clusters "MyClusters"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/resource-pool
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/resource-pool
x-vmw-doc-operation: list
Availability
Added in 7.0U2
On This Page
Resource Pool Operations
post
patch
delete
