This API has a deprecated equivalent from v7.0U1.
List Attached Objects On Tags Tag Association
Fetches the list of TagAssociation.TagToObjects describing the input tag identifiers and the objects they are attached to. To invoke this operation, you need the read privilege on each input tag. The TagAssociation.TagToObjects.object-ids will only contain those objects for which you have the read privilege.
Request
URLURL
https://{api_host}/api/cis/tagging/tag-association?action=list-attached-objects-on-tags
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
TaggingTagAssociationListAttachedObjectsOnTagsRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"tag_ids": [
"string"
]
}
array of
string
tag_ids
Required
The identifiers of the input tags. The parameter must contain identifiers for the resource type: com.vmware.cis.tagging.Tag.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
TaggingTagAssociationTagToObjects
of type application/json
The list of the tag identifiers to all object identifiers that each tag is attached to.
[
{
"object_ids": [
{
"id": "string",
"type": "string"
}
],
"tag_id": "string"
}
]
string
tag_id
Required
The identifier of the tag. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Tag. When operations return a value of this structure as a result, the field will be an identifier 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
$TaggingTagAssociationListAttachedObjectsOnTagsRequestBody = Initialize-TaggingTagAssociationListAttachedObjectsOnTagsRequestBody -TagIds "MyTagIds"
Invoke-ListAttachedObjectsOnTagsTagAssociation -TaggingTagAssociationListAttachedObjectsOnTagsRequestBody $TaggingTagAssociationListAttachedObjectsOnTagsRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"tag_ids":["string"]}' https://{api_host}/api/cis/tagging/tag-association?action=list-attached-objects-on-tags
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-objects-on-tags
x-vmw-doc-operation: list_attached_objects_on_tags
Availability
Added in 7.0U2
