XML element TagFilterSpec

Name: TagFilterSpec

Filter spec to query vCenter tags

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.TagFilterSpec",
   "allStats": <Boolean>,
   "categoryName": <String>,
   "hypervisorName": <String>,
   "limit": <Number>,
   "metric": <String>,
   "name": <String>,
   "offset": <Number>,
   "page": <Number>,
   "queryType": 'TOP_DOCS_BY_TIME' | 'TOP_DOCS_BY_LATEST_TIME' | 'OFFSET_BY_TIME' | 'OFFSET_BY_SEQUENCE',
   "refresh": <Boolean>,
   "replLinkId": Uuid,
   "since": <Date>,
   "sortedBy": <String>,
   "sortOrder": <String>,
   "tagId": <String>,
   "tagIds": [<String>],
   "tagName": <String>,
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP' | 'GENERIC_INTERFACE' | 'APPLIANCE' | 'VIRTUAL_VMSTORE',
   "timeout": <Number>,
   "until": <Date>,
   "uuid": <String>,
}

Name Type Description

allStats xsd:boolean For query param info, refer to: allStats

categoryName

xsd:string

**Query Param Info:**
Param Name:	categoryName
Description:	Category name to filter tags by
Multivalued:	No
Usage:	?categoryName=value

hypervisorName

xsd:string

**Query Param Info:**
Param Name:	hypervisorName
Description:	Hypervisor name to filter tags by
Multivalued:	No
Usage:	?hypervisorName=value

limit xsd:int For query param info, refer to: limit

metric xsd:string For query param info, refer to: metric

name xsd:string For query param info, refer to: name

offset xsd:int For query param info, refer to: offset

page xsd:int For query param info, refer to: page

queryType

TOP_DOCS_BY_TIME | TOP_DOCS_BY_LATEST_TIME | OFFSET_BY_TIME | OFFSET_BY_SEQUENCE

TOP_DOCS_BY_TIME	sort top contributors by time based on since and until values
TOP_DOCS_BY_LATEST_TIME	sort top contributors by time based on latest update time
OFFSET_BY_TIME	sort by time starting with a time offset
OFFSET_BY_SEQUENCE	sort by offset starting with a page offset

For query param info, refer to: queryType

refresh xsd:boolean For query param info, refer to: refresh

replLinkId Uuid For query param info, refer to: replLinkId

since xsd:datetime For query param info, refer to: since

sortedBy xsd:string For query param info, refer to: sortedBy

sortOrder xsd:string For query param info, refer to: sortOrder

tagId

xsd:string

**Query Param Info:** (TgcOnly)
Param Name:	tagId
Description:	Tag ID to filter tags by
Multivalued:	No
Usage:	?tagId=value

tagIds

xsd:list[xsd:string]

**Query Param Info:** (TgcOnly)
Param Name:	tagIds
Description:	List of Tag IDs
Multivalued:	Yes
Usage:	?tagIds=value1[,value2,value3..] OR ?tagIds=value1[&tagIds=value2&tagIds=value3...]

tagName

xsd:string

**Query Param Info:**
Param Name:	tagName
Description:	Tag name to filter tags by
Multivalued:	No
Usage:	?tagName=value

target

VM	Virtual machine
VDISK	Virtual disk
SNAPSHOT	Snapshot
JOB	Job
ALERTS	Alert
DATASTORE_STAT	Datastore statistics
VM_STAT	Virtual Machine statistics
VDISK_STAT	Virtual disk statistics
SERVICE_GROUP	Service group
GENERIC_INTERFACE	Generic Interface
APPLIANCE	Appliance
VIRTUAL_VMSTORE	Virtual VMstore

For query param info, refer to: target

timeout xsd:long For query param info, refer to: timeout

until xsd:datetime For query param info, refer to: until

uuid xsd:string For query param info, refer to: uuid