This API has a deprecated equivalent from v7.0U1.
List Attached Tags On Objects Tag Association
Fetches the list of TagAssociation.ObjectToTags describing the input object identifiers and the tags attached to each object. To invoke this operation, you need the read privilege on each input object. The TagAssociation.ObjectToTags.tag-ids will only contain those tags for which you have the read privilege.
Request
URLURL
https://{api_host}/api/cis/tagging/tag-association?action=list-attached-tags-on-objects
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"
Request Body
Request Body
TaggingTagAssociationListAttachedTagsOnObjectsRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"object_ids": [
{
"id": "string",
"type": "string"
}
]
}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
TaggingTagAssociationObjectToTags
of type application/json
The list of the object identifiers to all tag identifiers that are attached to that object.
[
{
"object_id": {
"id": "string",
"type": "string"
},
"tag_ids": [
"string"
]
}
]
array of
string
tag_ids
Required
The identifiers of the related tags. 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.
Errors
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
$StdDynamicID = Initialize-StdDynamicID -Type "MyType" -Id "MyId"
$TaggingTagAssociationListAttachedTagsOnObjectsRequestBody = Initialize-TaggingTagAssociationListAttachedTagsOnObjectsRequestBody -ObjectIds $StdDynamicID
Invoke-ListAttachedTagsOnObjectsTagAssociation -TaggingTagAssociationListAttachedTagsOnObjectsRequestBody $TaggingTagAssociationListAttachedTagsOnObjectsRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{}' https://{api_host}/api/cis/tagging/tag-association?action=list-attached-tags-on-objects
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/tagging/tag-association?~action=list-attached-tags-on-objects
x-vmw-doc-operation: list_attached_tags_on_objects
Availability
Added in 7.0U2
