Skip to main content

list

Addedv0.1.x

This operation lists all clusters.

Description

This command returns the following fields for each listed cluster:

  • clusterId

  • clusterName

  • description

  • regionId

  • cuType

  • plan

  • cuSize

  • status

Synopsis

zilliz cluster list
[--page-size <value>]
[--page <value>]
[--output <value>]
[--query <value>]
[--no-header]
[--all]

Options

  • --page-size (integer) -

    Indicates the items per page. The value defaults to 10.

  • --page (integer) -

    Indicates the page number. The value defaults to 1.

  • --output, -o (string) -

    Indicates the output format. Possible values:

    • json,

    • table,

    • text,

    • yaml,

    • csv.

  • --no-header (boolean) -

    Indicates whether to omit the header row when output is set to table or csv.

  • --query, -q (string) -

    Indicates a JMESPath expression to filter output.

  • --all, -a (boolean) -

    Indicates whether to fetch all pages.

Example

# List all clusters
zilliz cluster list

# Fetch all pages
zilliz cluster list --all