Skip to main content

describe

Addedv0.1.x

This operation gets details of a backup.

Description​

In Zilliz Cloud, a backup is a copy of your data that enables you to restore the entire cluster or specific collections in the event of data loss or system failure.

You can run this command to get the details of a backup.

📘Notes

This feature is available only to Dedicated clusters.

Synposis​

zilliz backup describe
--cluster-id <value>
--backup-id <value>
[--output <value>]
[--query <value>]
[--no-header]

Options​

  • --cluster-id (string) -

    [REQUIRED]

    Indicates a cluster ID, which is similar to inxx-xxxxx.

    If a cluster is configured using zilliz context set, it automatically applies if this option is left unconfigured.

  • --backup-id (string) -

    [REQUIRED]

    Indicates a backup ID, which is similar to backupx-xxxxx.

  • --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.

Example​

zilliz backup describe \
--cluster-id in01-xxxx \
--backup-id backup-xxxx