REST API - get

vcenter compute policies: get

Returns information about a specific compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Request:

HTTP request

GET https://{server}/api/vcenter/compute/policies/{policy}

Path Parameters

Name Type Description
Required
policy string Identifier of the policy for which information should be retrieved.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "capability""obj-103",
    "name""string",
    "description""string"
}

Headers:

None

Type:

Name Type Description
bold = required
-.name string Name of the policy. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

-.description string Description of the policy. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

-.capability string Identifier of the capability this policy is based on. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

- object 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.

Errors:

HTTP Status Code Type Description
404 not_found if a policy with this identifier does not exist.
403 unauthorized if the user doesn't have the required privileges.