List Associations
Returns tag associations that match the specified iteration spec.
Request
URLURL
https://{api_host}/api/vcenter/tagging/associations
Query Parameters
Query Parameters
string
marker
Optional
Marker is an opaque token that allows the caller to request the next page of tag associations. If unset or empty, first page of tag associations will be returned. 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.
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
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": "READY"
}
status
Required
The last status for the iterator. A field of this type is returned as part of the result and indicates to the caller of the API whether it can continue to make requests for more data. The last status only reports on the state of the iteration at the time data was last returned. As a result, it not does guarantee if the next call will succeed in getting more data or not.
Failures to retrieve results will be returned as Error responses. These last statuses are only returned when the iterator is operating as expected.
READY : Iterator has more data pending and is ready to provide it. The caller can request the next page of data at any time.
The number of results returned may be less than the usual size. In other words, the iterator may not fill the page. The iterator has returned at least 1 result.
END_OF_DATA : Iterator has finished iterating through its inventory. There are currently no more entities to return and the caller can terminate iteration. If the iterator returned some data, the marker may be set to allow the iterator to continue from where it left off when additional data does become available. This value is used to indicate that all available data has been returned by 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.
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.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListAssociations -Marker "MyMarker"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/tagging/associations
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.0
