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

array of string
clusters Optional

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.


array of string
datacenters Optional

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.


array of string
folders Optional

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.


array of string
names Optional

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

JSON Example

{
    "clusters": [
        "string"
    ],
    "datacenters": [
        "string"
    ],
    "folders": [
        "string"
    ],
    "names": [
        "string"
    ]
}
Feedback

Was this page helpful?