XML element TaskFilterSpec

Name: TaskFilterSpec

Job query parameter filter VMStore supports only a subset of filter params. Params supported by VMStore are jobType, jobTypes, state, targetId, startsWithId, createdBy, since

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.TaskFilterSpec",
   "allStats": <Boolean>,
   "createdBy": <String>,
   "id": <String>,
   "jobTarget": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP' | 'GENERIC_INTERFACE' | 'APPLIANCE' | 'VIRTUAL_VMSTORE',
   "jobType": 'SNAPSHOT' | 'CLONE' | 'REMOTE_COPY' | 'FAILOVER_TEST' | 'FAILOVER' | 'VM_SNAPSHOT_SYNC' | 'RECREATE_REPL_CONFIG' | 'SYNC_VM' | 'RELOCATE_VM' | 'SNAPSHOT_STORAGE_OBJECT' | 'CLONE_STORAGE_OBJECT' | 'CREATE_STORAGE_OBJECT' | 'UPDATE_STORAGE_OBJECT' | 'DELETE_STORAGE_OBJECT' | 'REVERT_STORAGE_OBJECT' | 'BIND_STORAGE_OBJECT' | 'UNBIND_STORAGE_OBJECT' | 'CLOUD_RESTORE' | 'CLOUD_REPO_ADOPTION' | 'EXPAND_CAPACITY' | 'TCE_DEPLOYMENT_CLEANUP' | 'TCE_DEPLOYMENT',
   "jobTypes": ['SNAPSHOT' | 'CLONE' | 'REMOTE_COPY' | 'FAILOVER_TEST' | 'FAILOVER' | 'VM_SNAPSHOT_SYNC' | 'RECREATE_REPL_CONFIG' | 'SYNC_VM' | 'RELOCATE_VM' | 'SNAPSHOT_STORAGE_OBJECT' | 'CLONE_STORAGE_OBJECT' | 'CREATE_STORAGE_OBJECT' | 'UPDATE_STORAGE_OBJECT' | 'DELETE_STORAGE_OBJECT' | 'REVERT_STORAGE_OBJECT' | 'BIND_STORAGE_OBJECT' | 'UNBIND_STORAGE_OBJECT' | 'CLOUD_RESTORE' | 'CLOUD_REPO_ADOPTION' | 'EXPAND_CAPACITY' | 'TCE_DEPLOYMENT_CLEANUP' | 'TCE_DEPLOYMENT'],
   "limit": <Number>,
   "metric": <String>,
   "name": <String>,
   "nativeTaskOnly": <Boolean>,
   "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>,
   "startsWithId": <String>,
   "state": 'QUEUED' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'CANCEL_PENDING' | 'ACKNOWLEDGED',
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP' | 'GENERIC_INTERFACE' | 'APPLIANCE' | 'VIRTUAL_VMSTORE',
   "targetId": <String>,
   "timeout": <Number>,
   "timeoutInSeconds": <Number>,
   "until": <Date>,
   "uuid": <String>,
   "vmstoreTaskId": <String>,
   "vmstoreTintriIds": [<String>],
}

Name Type Description

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

createdBy

xsd:string

**Query Param Info:**
Param Name:	createdBy
Description:	Username of the user initiating the task
Multivalued:	No
Usage:	?createdBy=value

xsd:string

**Query Param Info:**
Param Name:	id
Description:	Task resource Tintri UUID
Multivalued:	No
Usage:	?id=value

jobTarget

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

**Query Param Info:**
Param Name:	jobTarget
Description:	Either of (VM, VDISK, SNAPSHOT, JOB, ALERTS, DATASTORE_STAT, VM_STAT, VDISK_STAT, SERVICE_GROUP, GENERIC_INTERFACEAPPLIANCEVVMSTORE)
Multivalued:	No
Usage:	?jobTarget=value

jobType

SNAPSHOT	Snapshot job
CLONE	Clone job
REMOTE_COPY	Remote Copy job
FAILOVER_TEST	Failover test job
FAILOVER	Failover job
VM_SNAPSHOT_SYNC	Deprecated
RECREATE_REPL_CONFIG	Recreate replication configuation job
SYNC_VM	Sync virtual machine job
RELOCATE_VM	Relocate virtual machine job
SNAPSHOT_STORAGE_OBJECT	Snapshot storage object job
CLONE_STORAGE_OBJECT	Clone storage object job
CREATE_STORAGE_OBJECT	Create storage object job
UPDATE_STORAGE_OBJECT	Update storage object job
DELETE_STORAGE_OBJECT	Delete storage object job
REVERT_STORAGE_OBJECT	Revert storage object job
BIND_STORAGE_OBJECT	Bind storage object job
UNBIND_STORAGE_OBJECT	Unbind storage object job
CLOUD_RESTORE	Restore cloud snapshot
CLOUD_REPO_ADOPTION	Adopt cloud repository
EXPAND_CAPACITY	Expand capacity
TCE_DEPLOYMENT_CLEANUP	Clean TCE Deployment Resources
TCE_DEPLOYMENT	TCE Deployment Workflow

**Query Param Info:**
Param Name:	jobType
Description:	Either of (SNAPSHOT, CLONE, REMOTE_COPY, FAILOVER_TEST, FAILOVER, VM_SNAPSHOT_SYNC,RECREATE_REPL_CONFIG,SYNC_VM,RELOCATE_VMSNAPSHOT_STORAGE_OBJECTCLONE_STORAGE_OBJECTCREATE_STORAGE_OBJECTUPDATE_STORAGE_OBJECTDELETE_STORAGE_OBJECTREVERT_STORAGE_OBJECTBIND_STORAGE_OBJECTUNBIND_STORAGE_OBJECTCLOUD_RESTORECLOUD_REPO_ADOPTIONEXPAND_CAPACITYTCE_DEPLOYMENTTCE_DEPLOYMENT_CLEANUP)
Multivalued:	No
Usage:	?jobType=value

jobTypes

SNAPSHOT	Snapshot job
CLONE	Clone job
REMOTE_COPY	Remote Copy job
FAILOVER_TEST	Failover test job
FAILOVER	Failover job
VM_SNAPSHOT_SYNC	Deprecated
RECREATE_REPL_CONFIG	Recreate replication configuation job
SYNC_VM	Sync virtual machine job
RELOCATE_VM	Relocate virtual machine job
SNAPSHOT_STORAGE_OBJECT	Snapshot storage object job
CLONE_STORAGE_OBJECT	Clone storage object job
CREATE_STORAGE_OBJECT	Create storage object job
UPDATE_STORAGE_OBJECT	Update storage object job
DELETE_STORAGE_OBJECT	Delete storage object job
REVERT_STORAGE_OBJECT	Revert storage object job
BIND_STORAGE_OBJECT	Bind storage object job
UNBIND_STORAGE_OBJECT	Unbind storage object job
CLOUD_RESTORE	Restore cloud snapshot
CLOUD_REPO_ADOPTION	Adopt cloud repository
EXPAND_CAPACITY	Expand capacity
TCE_DEPLOYMENT_CLEANUP	Clean TCE Deployment Resources
TCE_DEPLOYMENT	TCE Deployment Workflow

**Query Param Info:**
Param Name:	jobTypes
Description:	List of (SNAPSHOT, CLONE, REMOTE_COPY, FAILOVER_TEST, FAILOVER, VM_SNAPSHOT_SYNC,RECREATE_REPL_CONFIG,SYNC_VM,RELOCATE_VMSNAPSHOT_STORAGE_OBJECTCLONE_STORAGE_OBJECTCREATE_STORAGE_OBJECTUPDATE_STORAGE_OBJECTDELETE_STORAGE_OBJECTREVERT_STORAGE_OBJECTBIND_STORAGE_OBJECTUNBIND_STORAGE_OBJECTCLOUD_RESTORECLOUD_REPO_ADOPTIONEXPAND_CAPACITYTCE_DEPLOYMENTTCE_DEPLOYMENT_CLEANUP)
Multivalued:	Yes
Usage:	?jobTypes=value1[,value2,value3..] OR ?jobTypes=value1[&jobTypes=value2&jobTypes=value3...]

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

nativeTaskOnly

xsd:boolean

Return nativeTaskOnly

**Query Param Info:** (TgcOnly)
Param Name:	nativeTaskOnly
Description:	Filter to return only native tasks running on the appliance
Multivalued:	No
Usage:	?nativeTaskOnly=value

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

startsWithId

xsd:string

**Query Param Info:**
Param Name:	startsWithId
Description:	Task resource Tintri UUID starts with
Multivalued:	No
Usage:	?startsWithId=value

state

QUEUED	Job is queued
RUNNING	Job is running
SUCCESS	Job finished successfully
FAILED	Job finished in failure
CANCELLED	Job was cancelled
CANCEL_PENDING	Job has a cancel pending
ACKNOWLEDGED	Not used at this time

**Query Param Info:**
Param Name:	state
Description:	Either of (QUEUED, RUNNING, SUCCESS, FAILED, CANCELLED, CANCEL_PENDING, ACKNOWLEDGED)
Multivalued:	No
Usage:	?state=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

targetId

xsd:string

**Query Param Info:**
Param Name:	targetId
Description:	Target resource Tintri Uuid
Multivalued:	No
Usage:	?targetId=value

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

timeoutInSeconds

xsd:int

**Query Param Info:**
Param Name:	timeoutInSeconds
Description:	Job wait time in seconds
Multivalued:	No
Usage:	?timeoutInSeconds=value

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

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

vmstoreTaskId

xsd:string

**Query Param Info:** (TgcOnly)
Param Name:	vmstoreTaskId
Description:	Uuid of task running on VMstore
Multivalued:	No
Usage:	?vmstoreTaskId=value

vmstoreTintriIds

xsd:list[xsd:string]

**Query Param Info:** (TgcOnly)
Param Name:	vmstoreTintriIds
Description:	List of TGC's VMstore IDs used to filter task list
Multivalued:	Yes
Usage:	?vmstoreTintriIds=value1[,value2,value3..] OR ?vmstoreTintriIds=value1[&vmstoreTintriIds=value2&vmstoreTintriIds=value3...]