vcenter resource pool: get
Retrieves information about the resource pool indicated by
resource_pool.
Request:
HTTP request
GET https://{server}/rest/vcenter/resource-pool/{resource_pool}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| resource_pool | string | Identifier of the resource pool for which information should be retrieved. |
Response:
HTTP Status Code: 200
Representations:
{
"value": {
"name": "string",
"resource_pools": [
"obj-103",
"obj-103"
]
}
}
"value": {
"name": "string",
"resource_pools": [
"obj-103",
"obj-103"
]
}
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vcenter/resource_pool" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<resource_pools-array>
<array-item>obj-103</array-item>
<array-item>obj-103</array-item>
</resource_pools-array>
<name>string</name>
</value>
</ns0:Get-Result>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vcenter/resource_pool" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<resource_pools-array>
<array-item>obj-103</array-item>
<array-item>obj-103</array-item>
</resource_pools-array>
<name>string</name>
</value>
</ns0:Get-Result>
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | information about the resource pool. |
| value.name | string | Name of the vCenter Server resource pool. |
| value.resource_pools | string[] | 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. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if the resource pool indicated by resource_pool does not exist. |
| 503 | service_unavailable | if the system is unable to communicate with a service to complete the request. |
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user doesn't have the required privileges. |