Name: VirtualDiskFilterSpec

VirtualDisk query parameter filter

Data Structure
{
   "typeId": "com.tintri.api.rest.v310.dto.VirtualDiskFilterSpec",
   "allStats": <Boolean>,
   "autoAligned": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "cloneDedupeFactor": <String>,
   "compressionFactor": <String>,
   "dedupeFactor": <String>,
   "displayName": <String>,
   "filterAttributeList": [SortFilterAttribute],
   "filterParams": MultivaluedMap,
   "flashHitPercent": <String>,
   "instanceUuid": <String>,
   "ioAlignedPercent": <String>,
   "isDiskDrive": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "latencyContentionMs": <String>,
   "latencyDiskMs": <String>,
   "latencyFlashMs": <String>,
   "latencyHostMs": <String>,
   "latencyNetworkMs": <String>,
   "latencyStorageMs": <String>,
   "latencyThrottleMs": <String>,
   "latencyTotalMs": <String>,
   "limit": <Number>,
   "liveLogicalFootprint": <String>,
   "metric": <String>,
   "name": <String>,
   "offset": <Number>,
   "offsetType": 'POSITION' | 'NAME' | 'UUID' | 'INVALID',
   "offsetValue": <Object>,
   "page": <Number>,
   "path": <String>,
   "performanceReserveAutoAllocated": <String>,
   "performanceReserveChange": <String>,
   "performanceReserveChangePercent": <String>,
   "performanceReserveUsed": <String>,
   "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,
   "requestSizeKiB": <String>,
   "since": <Date>,
   "sortedBy": <String>,
   "sortOrder": <String>,
   "spaceProvisionedGiB": <String>,
   "spaceSavingsFactor": <String>,
   "spaceUsedChangeGiB": <String>,
   "spaceUsedChangePercent": <String>,
   "spaceUsedGiB": <String>,
   "spaceUsedLiveGiB": <String>,
   "spaceUsedSnapshotsHypervisorGiB": <String>,
   "spaceUsedSnapshotsTintriGiB": <String>,
   "syslogForwarding": <String>,
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP',
   "timeout": <Number>,
   "totalIops": <String>,
   "totalMBps": <String>,
   "totalNormalizedIops": <String>,
   "totalUsedSpace": <String>,
   "until": <Date>,
   "uuid": <String>,
   "vmName": <String>,
   "vmUuid": <String>,
}

Elements
NameTypeDescription
allStatsxsd:boolean
For query param info, refer to: allStats
autoAlignedBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: autoAligned
Description: Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualDisk.isAutoAligned
Usage: ?autoAligned=value
cloneDedupeFactorxsd:string
For query param info, refer to: cloneDedupeFactor
compressionFactorxsd:string
For query param info, refer to: compressionFactor
dedupeFactorxsd:string
For query param info, refer to: dedupeFactor
displayNamexsd:string
Query Param Info:
Param Name: displayName
Description: Virtual Disk display name
Multivalued: No
Mapped to attributes:
  • VirtualDisk.displayName
Usage: ?displayName=value
filterAttributeListxsd: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.
filterParamsMultivaluedMap
flashHitPercentxsd:string
For query param info, refer to: flashHitPercent
instanceUuidxsd:string
For query param info, refer to: instanceUuid
ioAlignedPercentxsd:string
For query param info, refer to: ioAlignedPercent
isDiskDriveBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: isDiskDrive
Description: Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualDisk.isDiskDrive
Usage: ?isDiskDrive=value
latencyContentionMsxsd:string
For query param info, refer to: latencyContentionMs
latencyDiskMsxsd:string
For query param info, refer to: latencyDiskMs
latencyFlashMsxsd:string
For query param info, refer to: latencyFlashMs
latencyHostMsxsd:string
For query param info, refer to: latencyHostMs
latencyNetworkMsxsd:string
For query param info, refer to: latencyNetworkMs
latencyStorageMsxsd:string
For query param info, refer to: latencyStorageMs
latencyThrottleMsxsd:string
For query param info, refer to: latencyThrottleMs
latencyTotalMsxsd:string
For query param info, refer to: latencyTotalMs
limitxsd:int
For query param info, refer to: limit
liveLogicalFootprintxsd:string
For query param info, refer to: liveLogicalFootprint
metricxsd:string
For query param info, refer to: metric
namexsd:string
For query param info, refer to: name
offsetxsd:int
For query param info, refer to: offset
offsetTypePOSITION | NAME | UUID | INVALIDThe offset type of 'offsetValue'.
POSITIONoffsetType is a position in the page
NAMEoffterType is a name string
UUIDofftestType is a name UUID
INVALIDofftestType is invalid
offsetValuexsd:anyThe offset value in the terms of 'offsetType'.
pagexsd:int
For query param info, refer to: page
pathxsd:string
Query Param Info:
Param Name: path
Description: Virtual Disk path
Multivalued: No
Mapped to attributes:
  • VirtualDisk.path
Usage: ?path=value
performanceReserveAutoAllocatedxsd:string
For query param info, refer to: performanceReserveAutoAllocated
performanceReserveChangexsd:string
For query param info, refer to: performanceReserveChange
performanceReserveChangePercentxsd:string
For query param info, refer to: performanceReserveChangePercent
performanceReserveUsedxsd:string
For query param info, refer to: performanceReserveUsed
qParamsMultivaluedMap
QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAXxsd:intMax job completion timeout (in minutes)
QUERY_TIMEOUT_IN_SEC_DEFAULTxsd:intDefault search timeout (in seconds)
QUERY_TIMEOUT_IN_SEC_MAXxsd:intMax search timeout (in seconds)
queryTypeTOP_DOCS_BY_TIME | TOP_DOCS_BY_LATEST_TIME | OFFSET_BY_TIME | OFFSET_BY_SEQUENCE
TOP_DOCS_BY_TIMEsort top contributors by time based on since and until values
TOP_DOCS_BY_LATEST_TIMEsort top contributors by time based on latest update time
OFFSET_BY_TIMEsort by time starting with a time offset
OFFSET_BY_SEQUENCEsort by offset starting with a page offset
For query param info, refer to: queryType
refreshxsd:boolean
For query param info, refer to: refresh
replLinkIdUuid
For query param info, refer to: replLinkId
requestSizeKiBxsd:string
For query param info, refer to: requestSizeKiB
sincexsd:datetime
For query param info, refer to: since
sortedByxsd:string
For query param info, refer to: sortedBy
sortOrderxsd:string
For query param info, refer to: sortOrder
spaceProvisionedGiBxsd:string
For query param info, refer to: spaceProvisionedGiB
spaceSavingsFactorxsd:string
For query param info, refer to: spaceSavingsFactor
spaceUsedChangeGiBxsd:string
For query param info, refer to: spaceUsedChangeGiB
spaceUsedChangePercentxsd:string
For query param info, refer to: spaceUsedChangePercent
spaceUsedGiBxsd:string
For query param info, refer to: spaceUsedGiB
spaceUsedLiveGiBxsd:string
For query param info, refer to: spaceUsedLiveGiB
spaceUsedSnapshotsHypervisorGiBxsd:string
For query param info, refer to: spaceUsedSnapshotsHypervisorGiB
spaceUsedSnapshotsTintriGiBxsd:string
For query param info, refer to: spaceUsedSnapshotsTintriGiB
syslogForwardingxsd:string
For query param info, refer to: syslogForwarding
targetVM | VDISK | SNAPSHOT | JOB | ALERTS | DATASTORE_STAT | VM_STAT | VDISK_STAT | SERVICE_GROUP
VMVirtual machine
VDISKVirtual disk
SNAPSHOTSnapshot
JOBJob
ALERTSAlert
DATASTORE_STATDatastore statistics
VM_STATVirtual Machine statistics
VDISK_STATVirtual disk statistics
SERVICE_GROUPService group
For query param info, refer to: target
timeoutxsd:long
For query param info, refer to: timeout
totalIopsxsd:string
For query param info, refer to: totalIops
totalMBpsxsd:string
For query param info, refer to: totalMBps
totalNormalizedIopsxsd:string
For query param info, refer to: totalNormalizedIops
totalUsedSpacexsd:string
For query param info, refer to: totalUsedSpace
untilxsd:datetime
For query param info, refer to: until
uuidxsd:string
For query param info, refer to: uuid
vmNamexsd:string
Query Param Info:
Param Name: vmName
Description: Name of the VM the Virtual Disk belongs to
Multivalued: No
Mapped to attributes:
  • VirtualDisk.vmName
Usage: ?vmName=value
vmUuidxsd:string
Query Param Info:
Param Name: vmUuid
Description: Tintri Uuid of VM this disk belongs to
Multivalued: No
Mapped to attributes:
  • VirtualDisk.vmUuid.uuid
Usage: ?vmUuid=value