This API has a deprecated equivalent from v7.0U1.
Get Resource Pool
Retrieves information about the resource pool indicated by resourcePool. if you do not have all of the privileges described as follows: - The resource ResourcePool referenced by the parameter resourcePool requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/resource-pool/{resource_pool}
Path Parameters
Path Parameters
string
resource_pool
Required
Identifier of the resource pool for which information should be retrieved. The parameter must be an identifier 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
ResourcePoolInfo
of type application/json
Information about the resource pool.
{
"cpu_allocation": {
"expandable_reservation": false,
"limit": 0,
"reservation": 0,
"shares": {
"level": "LOW",
"shares": 0
}
},
"memory_allocation": {
"expandable_reservation": false,
"limit": 0,
"reservation": 0,
"shares": {
"level": "LOW",
"shares": 0
}
},
"name": "string",
"resource_pools": [
"string"
]
}
string
name
Required
Name of the vCenter Server resource pool.
array of
string
resource_pools
Required
Identifiers of the child resource pools contained in this resource pool. 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.
cpu_allocation
Optional
Resource allocation information for CPU. This field is optional because it was added in a newer version than its parent node.
memory_allocation
Optional
Resource allocation information for memory. This field is optional because it was added in a newer version than its parent node.
Errors
403
com.vmware.vapi.std.errors.unauthorized : If the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : If the resource pool indicated by resourcePool does not exist.
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-GetResourcePool -ResourcePool "MyResourcePool"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/resource-pool/{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/{resource_pool}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Resource Pool Operations
post
patch
delete
