Developer Documentation
List Associations
Released in v7.0.0Returns tag associations that match the specified iteration spec.
Request
URLURL
https://{api_host}/api/vcenter/tagging/associations
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
AssociationsIterationSpec | The specification of a page to be retrieved. If unset, the first page will be retrieved. |
Response
Response
Response BodyResponse Body
200 OK returns
AssociationsListResult
of type application/json
A page of the tag associations matching the iteration spec.
{
"associations": [
{
"tag": "string"
}
],
"marker": "string",
"status": "enum"
}| Property Name | Type | Description |
|---|---|---|
| associations | array of AssociationsSummary |
List of tag associations. |
| status | AssociationsLastIterationStatus Enum |
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. |
| marker | string |
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
| Code | Returns | Description |
|---|---|---|
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : if Associations.IterationSpec.marker is not a marker returned from an earlier invocation of this {@term operation). |
| 401 | Error | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
| default | Error | Not available |
