Skip to main content

describe

Addedv0.1.x

This operation gets the status of an async job (backup, restore, migration, import, etc.).

Synopsis

zilliz job describe
--job-id <value>
[--wait]
[--timeout <value>]
[--interval <value>]
[--output <value>]

Options

  • --job-id (string) -

    [REQUIRED]

    Indicates a Job ID. For example, job-xxxxxxxxxxxxxxxxxxxx.

  • --wait (boolean) -

    Indicates whether to wait until the job reaches a termination state.

  • --timeout (integer) -

    Indicates the maximum number of seconds to wait. The value defaults to 1800.

  • --interval (integer) -

    Indicates the polling interval in seconds. The value defaults to 5, indicating that Zilliz Cloud retrieves the status of the specified job every 5 seconds.

  • --output, -o (string) -

    Indicates the output format. Choices: json, table, text, yaml, csv.

Example

zilliz job describe --job-id job-xxxxxx