Overview
detail: element | attribute | value

Name: K8sFilterSpec

Filter spec to query k8s objects like pods, containers, persistent volumes and volume claims

Data Structure
{
   "typeId": "com.tintri.api.rest.v310.dto.K8sFilterSpec",
   "accessMode": <String>,
   "allStats": <Boolean>,
   "annotationKey": <String>,
   "annotationValue": <String>,
   "clusterName": <String>,
   "hypervisorName": <String>,
   "labelKey": <String>,
   "labelValue": <String>,
   "limit": <Number>,
   "metric": <String>,
   "name": <String>,
   "namespace": <String>,
   "offset": <Number>,
   "page": <Number>,
   "podName": <String>,
   "podUuid": <String>,
   "pvcName": <String>,
   "pvcNameForPod": <String>,
   "pvcUuid": <String>,
   "pvName": <String>,
   "pvPodUuid": <String>,
   "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>,
   "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>,
   "uuids": [<String>],
   "vdUuid": <String>,
   "vmInstanceUuid": <String>,
   "vmName": <String>,
   "vmTintriUuid": <String>,
}
Elements
NameTypeDescription
accessModexsd:string
Query Param Info:
Param Name: accessMode
Description: Access mode to filter k8s persistent volume or persistent volume claim
Multivalued: No
Mapped to attributes:
  • K8sEntity.accessModes
Usage: ?accessMode=value
allStatsxsd:boolean
For query param info, refer to: allStats
annotationKeyxsd:string
Query Param Info:
Param Name: annotationKey
Description: Key part of annotation to filter k8s objects by
Multivalued: No
Mapped to attributes:
  • K8sEntity.annotations
Usage: ?annotationKey=value
annotationValuexsd:string
Query Param Info:
Param Name: annotationValue
Description: Value part of annotation to filter k8s objects by
Multivalued: No
Usage: ?annotationValue=value
clusterNamexsd:string
Query Param Info:
Param Name: clusterName
Description: K8s cluster name to filter k8s objects by
Multivalued: No
Mapped to attributes:
  • K8sEntity.clusterName
Usage: ?clusterName=value
hypervisorNamexsd:string
Query Param Info:
Param Name: hypervisorName
Description: Hypervisor name to filter k8s objects by
Multivalued: No
Mapped to attributes:
  • K8sEntity.hypervisorName
Usage: ?hypervisorName=value
labelKeyxsd:string
Query Param Info:
Param Name: labelKey
Description: Key part of label to filter k8s objects by
Multivalued: No
Mapped to attributes:
  • K8sEntity.labels
Usage: ?labelKey=value
labelValuexsd:string
Query Param Info:
Param Name: labelValue
Description: Value part of label to filter k8s objects by
Multivalued: No
Usage: ?labelValue=value
limitxsd:int
For query param info, refer to: limit
metricxsd:string
For query param info, refer to: metric
namexsd:string
Query Param Info:
Param Name: name
Description: k8s entity name to filter k8s objects by
Multivalued: No
Mapped to attributes:
  • K8sEntity.name
Usage: ?name=value
namespacexsd:string
Query Param Info:
Param Name: namespace
Description: Namespace to filter k8s objects by
Multivalued: No
Mapped to attributes:
  • K8sEntity.namespace
Usage: ?namespace=value
offsetxsd:int
For query param info, refer to: offset
pagexsd:int
For query param info, refer to: page
podNamexsd:string
Query Param Info:
Param Name: podName
Description: Pod name to filter k8s containers by
Multivalued: No
Mapped to attributes:
  • K8sEntity.podName
Usage: ?podName=value
podUuidxsd:string
Query Param Info:
Param Name: podUuid
Description: Pod uuid to filter k8s containers by
Multivalued: No
Mapped to attributes:
  • K8sEntity.podUuid
Usage: ?podUuid=value
pvcNamexsd:string
Query Param Info:
Param Name: pvcName
Description: PVC name to filter k8s persistent volume by
Multivalued: No
Mapped to attributes:
  • K8sEntity.pvcName
Usage: ?pvcName=value
pvcNameForPodxsd:string
Query Param Info:
Param Name: pvcNameForPod
Description: PVC name to filter k8s pod by
Multivalued: No
Mapped to attributes:
  • K8sEntity.volumes.pvcRefName
Usage: ?pvcNameForPod=value
pvcUuidxsd:string
Query Param Info:
Param Name: pvcUuid
Description: PVC uuid to filter k8s persistent volume by
Multivalued: No
Mapped to attributes:
  • K8sEntity.pvcUuid
Usage: ?pvcUuid=value
pvNamexsd:string
Query Param Info:
Param Name: pvName
Description: PV name to filter k8s persistent volume claim by
Multivalued: No
Mapped to attributes:
  • K8sEntity.volumeName
Usage: ?pvName=value
pvPodUuidxsd:string
Query Param Info:
Param Name: pvPodUuid
Description: Pod uuid to filter k8s persistent volume/volume claims by
Multivalued: No
Mapped to attributes:
  • K8sEntity.podUuids
Usage: ?pvPodUuid=value
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
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
targetVM | VDISK | SNAPSHOT | JOB | ALERTS | DATASTORE_STAT | VM_STAT | VDISK_STAT | SERVICE_GROUP | GENERIC_INTERFACE | APPLIANCE | VIRTUAL_VMSTORE
VMVirtual machine
VDISKVirtual disk
SNAPSHOTSnapshot
JOBJob
ALERTSAlert
DATASTORE_STATDatastore statistics
VM_STATVirtual Machine statistics
VDISK_STATVirtual disk statistics
SERVICE_GROUPService group
GENERIC_INTERFACEGeneric Interface
APPLIANCEAppliance
VIRTUAL_VMSTOREVirtual VMstore
For query param info, refer to: target
timeoutxsd:long
For query param info, refer to: timeout
untilxsd:datetime
For query param info, refer to: until
uuidxsd:string
For query param info, refer to: uuid
uuidsxsd:list[xsd:string]
Query Param Info:
Param Name: uuids
Description: List of Uuids
Multivalued: Yes
Usage:
  • ?uuids=value1[,value2,value3..] OR
  • ?uuids=value1[&uuids=value2&uuids=value3...]
vdUuidxsd:string
Query Param Info:
Param Name: vdUuid
Description: Virtual Disk uuid to filter k8s persistent volume or persistent volume claim
Multivalued: No
Mapped to attributes:
  • K8sEntity.vdUuid
Usage: ?vdUuid=value
vmInstanceUuidxsd:string
Query Param Info:
Param Name: vmInstanceUuid
Description: VM instance uuid to filter k8s objects by
Multivalued: No
Mapped to attributes:
  • K8sEntity.vmInstanceUuid
Usage: ?vmInstanceUuid=value
vmNamexsd:string
Query Param Info:
Param Name: vmName
Description: VM name to filter k8s objects by
Multivalued: No
Mapped to attributes:
  • K8sEntity.vmName
Usage: ?vmName=value
vmTintriUuidxsd:string
Query Param Info:
Param Name: vmTintriUuid
Description: VM Tintri uuid to filter k8s objects by
Multivalued: No
Mapped to attributes:
  • K8sEntity.vmTintriUuid
Usage: ?vmTintriUuid=value
Overview
detail: element | attribute | value
Generated by Lunatech Labs jax-doclets v0.8