XML element AlertFilterSpec

Name: AlertFilterSpec

Alert query parameter filter

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.AlertFilterSpec",
   "allStats": <Boolean>,
   "filterAttributeList": [SortFilterAttribute],
   "filterParams": MultivaluedMap,
   "limit": <Number>,
   "message": <String>,
   "metric": <String>,
   "name": <String>,
   "offset": <Number>,
   "offsetType": 'POSITION' | 'NAME' | 'UUID' | 'INVALID',
   "offsetValue": <Object>,
   "page": <Number>,
   "qParams": MultivaluedMap,
   "QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAX": <Number>,
   "QUERY_TIMEOUT_IN_SEC_DEFAULT": <Number>,
   "QUERY_TIMEOUT_IN_SEC_MAX": <Number>,
   "queryType": 'TOP_DOCS_BY_TIME' | 'TOP_DOCS_BY_LATEST_TIME' | 'OFFSET_BY_TIME' | 'OFFSET_BY_SEQUENCE',
   "refresh": <Boolean>,
   "replLinkId": Uuid,
   "severities": ['ALERT' | 'NOTICE'],
   "severity": 'ALERT' | 'NOTICE',
   "since": <Date>,
   "sortedBy": <String>,
   "sortOrder": <String>,
   "sources": [<String>],
   "state": 'NEW' | 'ACKNOWLEDGED' | 'ARCHIVED',
   "states": ['NEW' | 'ACKNOWLEDGED' | 'ARCHIVED'],
   "syslogForwarding": <String>,
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP',
   "timeout": <Number>,
   "until": <Date>,
   "uuid": <String>,
}

Name Type Description

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

filterAttributeList xsd:list[SortFilterAttribute] Iterates over all the @Filter query params and builds SortFilterAttribute objects from it. SortFilterAttribute wraps attribute name and String value; per mapped attribute.

filterParams MultivaluedMap

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

message

xsd:string

**Query Param Info:** (TgcOnly)
Param Name:	message
Description:	The message text filter for request alerts. It could be partial or full match of the alert message text
Multivalued:	No
Usage:	?message=value

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

offsetType

POSITION | NAME | UUID | INVALID

The offset type of 'offsetValue'.

POSITION	offsetType is a position in the page
NAME	offterType is a name string
UUID	offtestType is a name UUID
INVALID	offtestType is invalid

offsetValue xsd:any The offset value in the terms of 'offsetType'.

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

qParams MultivaluedMap

QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAX xsd:int Max job completion timeout (in minutes)

QUERY_TIMEOUT_IN_SEC_DEFAULT xsd:int Default search timeout (in seconds)

QUERY_TIMEOUT_IN_SEC_MAX xsd:int Max search timeout (in seconds)

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

severities

xsd:list[ALERT | NOTICE]

ALERT	Alert message type
NOTICE	Notice message type

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

severity

ALERT | NOTICE

ALERT	Alert message type
NOTICE	Notice message type

**Query Param Info:**
Param Name:	severity
Description:	One of (ALERT, NOTICE)
Multivalued:	No
Usage:	?severity=value

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

sources

xsd:list[xsd:string]

**Query Param Info:** (TgcOnly)
Param Name:	sources
Description:	The sources filter(which VMstore is this alert reported) for request alerts
Multivalued:	Yes
Usage:	?sources=value1[,value2,value3..] OR ?sources=value1[&sources=value2&sources=value3...]

state

NEW | ACKNOWLEDGED | ARCHIVED

NEW	New alert, typically un-read and non-archieved.
ACKNOWLEDGED	Acknowledged alert.
ARCHIVED	Archived alert.

**Query Param Info:**
Param Name:	state
Description:	One of (NEW, ACKNOWLEDGED, ARCHIVED)
Multivalued:	No
Usage:	?state=value

states

xsd:list[NEW | ACKNOWLEDGED | ARCHIVED]

NEW	New alert, typically un-read and non-archieved.
ACKNOWLEDGED	Acknowledged alert.
ARCHIVED	Archived alert.

**Query Param Info:** (TgcOnly)
Param Name:	states
Description:	List of (NEW, ACKNOWLEDGED, ARCHIVED)
Multivalued:	Yes
Usage:	?states=value1[,value2,value3..] OR ?states=value1[&states=value2&states=value3...]

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

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

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