List Policies Tag Usage
Returns information about the tags used by policies available in this vCenter server matching the TagUsage.FilterSpec. 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/tag-usage
Query Parameters
Query Parameters
array of
string
policies
Optional
Identifiers that compute policies must have to match the filter. If unset or empty, then tags used by any policy match this filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.compute.Policy. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.compute.Policy.
array of
string
tag_types
Optional
Identifiers that tag types must have to match the filter. If unset or empty, then tags of any type match this filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vapi.resource. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vapi.resource.
array of
string
tags
Optional
Identifiers that tags must have to match the filter. If unset or empty, then tags with any tag identifier match this filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.cis.tagging.Tag. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.
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
ComputePoliciesTagUsageSummary
of type application/json
The list of tags used by policies available on this vCenter server matching the TagUsage.FilterSpec.
[
{
"category_name": "string",
"policy": "string",
"tag": "string",
"tag_name": "string",
"tag_type": "string"
}
]
string
category_name
Required
Name of the category that has TagUsage.Summary.tag.
string
policy
Required
Identifier of the policy that uses the tag indicated by TagUsage.Summary.tag. 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.
string
tag
Required
Identifier of the tag used by the policy indicated by TagUsage.Summary.policy. When clients pass a value of this structure as a parameter, the field TagUsage.Summary.tag-type must contain the actual resource type. When operations return a value of this structure as a result, the field TagUsage.Summary.tag-type will contain the actual resource type.
string
tag_name
Required
Name of the tag used by the policy indicated by TagUsage.Summary.policy.
string
tag_type
Required
Identifier of the tag type used by the policy indicated by TagUsage.Summary.policy. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.resource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.resource.
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/tag-usage
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
