Vcenter ResourcePool get

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 requires System.Read.
Request
URI
GET
https://{api_host}/api/vcenter/resource-pool/{resourcePool}
COPY
Path Parameters
string
resourcePool
Required

Identifier of the resource pool for which information should be retrieved.

The parameter must be an identifier for the resource type: ResourcePool.


Authentication
This operation uses the following authentication methods.
Responses
200

Information about the resource pool.

Returns Vcenter ResourcePool Info of type(s) application/json
{
    "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
        }
    }
}
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 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.

cpu_allocation
Optional

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.

memory_allocation
Optional

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.


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"

404

If the resource pool indicated by resourcePool does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound 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/{resourcePool}