more than half documented
List Associations
DescriptionReturns tag associations that match the specified iteration spec.
Request
URLURL
https://{api_host}/api/vcenter/tagging/associations
Query Parameters
Query Parameters
iterate
Optional
The specification of a page to be retrieved.
If unset, the first page will be retrieved.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Response
Response
Response BodyResponse Body
200 OK returns
TaggingAssociationsListResult of type application/json
A page of the tag associations matching the iteration spec.
{
"associations": [
{
"object": {
"id": "string",
"type": "string"
},
"tag": "string"
}
],
"marker": "string",
"status": "enum"
}
status
Required
The last status for the iterator that indicates whether any more results can be expected if the caller continues to make requests for more data using the iterator.
Possible values are: READY , END_OF_DATA
string
marker
Optional
Marker is an opaque data structure that allows the caller to request the next page of tag associations. If unset or empty, there are no more tag associations to request. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.tagging.associations.Marker. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.tagging.associations.Marker.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/tagging/associations
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if Associations.IterationSpec.marker is not a marker returned from an earlier invocation of this {@term operation).
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
Availability
Added in 7.0.0
