List Policies
Returns information about the compute policies available in this vCenter server. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/compute/policies
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
array of
ComputePoliciesSummary
of type application/json
The list of compute policies available on this vCenter server.
[
{
"capability": "string",
"description": "string",
"name": "string",
"policy": "string"
}
]
string
capability
Required
Identifier of the capability this policy is based on. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.
string
description
Required
Description of the policy.
string
name
Required
Name of the policy.
string
policy
Required
Identifier of the policy. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.compute.Policy. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.compute.Policy.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/compute/policies
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.3.0
