Skip to main content

describe-policy

Addedv0.1.x

This operation describes the backup policy for a cluster.

Description​

Zilliz Cloud allows you to enable automatic backups for your clusters, helping ensure data recovery in case of unexpected issues. Automatic backups apply to the entire cluster—backing up individual collections automatically is not supported.

You can run this command to learn about the settings of the current automatic backup policies that apply to the specified cluster.

📘Notes

This feature is available only to Dedicated clusters.

Synopsis​

zilliz backup describe-policy
--cluster-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.

  • --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-policy --cluster-id in01-xxxxxxxxxxxx