Developer Documentation

ClusterFilterSpec

The Cluster.FilterSpec structure contains fields used to filter the results when listing clusters (see Cluster.list). If multiple fields are specified, only clusters matching all of the fields match the filter.


Properties

Required Property Name Type Description
optional clusters array of string

Identifiers of clusters that can match the filter. If unset or empty, clusters with any identifier match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ClusterComputeResource.

optional datacenters array of string

Datacenters that must contain the cluster for the cluster to match the filter. If unset or empty, clusters in any datacenter match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datacenter. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datacenter.

optional folders array of string

Folders that must contain the cluster for the cluster to match the filter. If unset or empty, clusters in any folder match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Folder. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Folder.

optional names array of string

Names that clusters must have to match the filter (see Cluster.Info.name). If unset or empty, clusters with any name match the filter.

Parameter To


List Cluster
Feedback

Was this page helpful?