Vcenter ResourcePool get
Retrieves information about the resource pool indicated by resourcePool.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
ResourcePool
referenced by the parameter resourcePool requiresSystem.Read
.
Identifier of the resource pool for which information should be retrieved.
The parameter must be an identifier for the resource type: ResourcePool
.
Information about the resource pool.
{
"name": "string",
"resource_pools": [
"string"
],
"cpu_allocation": {
"reservation": 0,
"expandable_reservation": false,
"limit": 0,
"shares": {
"level": "string",
"shares": 0
}
},
"memory_allocation": {
"reservation": 0,
"expandable_reservation": false,
"limit": 0,
"shares": {
"level": "string",
"shares": 0
}
}
}
Name of the vCenter Server resource pool.
Identifiers of the child resource pools contained in this resource pool.
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
.
Resource allocation information for CPU.
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.
Resource allocation information for memory.
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.
If the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"
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.
If the user doesn't have the required privileges.
"Vapi Std Errors Unauthorized Object"
If the resource pool indicated by resourcePool does not exist.
"Vapi Std Errors NotFound Object"
If the system is unable to communicate with a service to complete the request.
"Vapi Std Errors ServiceUnavailable Object"
curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/resource-pool/{resourcePool}