Vcenter Compute Policies get
Returns information about a specific compute policy.
This operation was added in vSphere API 7.0.3.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
System.Read
.
Identifier of the policy for which information should be retrieved.
The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy
.
Detailed information about the specified compute policy. The returned value can be converted to the information type of the capability that this policy is based on. See Vcenter Compute Policies Capabilities Info.info_type.
The response will contain all the properties defined in Vcenter Compute Policies Info.
{
"name": "string",
"description": "string",
"capability": "string"
}
Name of the policy.
This property was added in vSphere API 7.0.3.0.
Description of the policy.
This property was added in vSphere API 7.0.3.0.
Identifier of the capability this policy is based on.
This property was added in vSphere API 7.0.3.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability
. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability
.
if the user doesn't have the required privileges.
"Vapi Std Errors Unauthorized Object"
if a policy with this identifier does not exist.
"Vapi Std Errors NotFound Object"
curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/compute/policies/{policy}