Vcenter Compute Policies Capabilities get

Vcenter Compute Policies Capabilities get

Returns information about a specific compute policy capability.

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.
Request
URI
GET
https://{api_host}/api/vcenter/compute/policies/capabilities/{capability}
COPY
Path Parameters
string
capability
Required

Identifier of the capability for which information should be retrieved.

The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.


Authentication
This operation uses the following authentication methods.
Responses
200

Detailed information about the capability.

Returns Vcenter Compute Policies Capabilities Info of type(s) application/json
{
    "name": "string",
    "description": "string",
    "create_spec_type": "string",
    "info_type": "string"
}
string
name
Required

Name of the capability.

This property was added in vSphere API 7.0.3.0.

string
description
Required

Description of the capability.

This property was added in vSphere API 7.0.3.0.

string
create_spec_type
Required

Identifier of the schema used to create a policy based on this capability. See POST /vcenter/compute/policies.

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.vapi.structure. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.structure.

string
info_type
Required

Identifier of the schema returned when retrieving information about a policy based on this capability. See GET /vcenter/compute/policies/{policy}.

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.vapi.structure. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.structure.


403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0
"Vapi Std Errors Unauthorized Object"

404

if a capability with this identifier does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/compute/policies/capabilities/{capability}