REST API - get

vcenter compute policies capabilities: get

Returns information about a specific compute policy capability 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/capabilities/{capability}

Path Parameters

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

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "info_type""obj-103",
    "name""string",
    "description""string",
    "create_spec_type""obj-103"
}

Headers:

None

Type:

Name Type Description
bold = required
- info Detailed information about the capability.
-.name string Name of the capability. 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 capability. 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.

-.create_spec_type string Identifier of the structure used to create a policy based on this capability. See create. 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.vapi.structure. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.structure.

-.info_type string Identifier of the structure returned when retrieving information about a policy based on this capability. See get. 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.vapi.structure. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.structure.

Errors:

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