Prerequisites
- CLI installed and logged in (see setup skill).
- A job ID from a previous async operation (backup create, import start, etc.).
Commands Reference
Describe a Job
zilliz job describe --job-id <job-id>
Wait for Completion
The job describe command supports a --wait flag to poll until the job finishes:
# Poll until done (default: 5s interval, 30min timeout)
zilliz job describe --job-id <job-id> --wait
# Custom timeout and interval
zilliz job describe --job-id <job-id> --wait --timeout 600 --interval 10
Job Types
| Type | Triggered By |
|---|---|
| BACKUP | backup create |
| RESTORE | backup restore-cluster, backup restore-collection |
| IMPORT | import start |
| MIGRATION | Cloud migration operations |
| CLONE_COLLECTION | Collection clone operations |
Job Statuses
| Status | Meaning |
|---|---|
| PENDING | Job is queued |
| IN_PROGRESS | Job is running |
| SUCCESSFUL | Job completed successfully |
| FAILED | Job failed (check reason field) |
| CANCELING | Job is being cancelled |
| CANCELED | Job was cancelled |
Guidance
- Many control-plane operations are asynchronous and return a
jobId. Suggest usingjob describeto track progress. - When a job fails, the
reasonfield contains the error message. Display it to the user. - For long-running operations (cluster creation, data migration), suggest using
--waitso the user doesn't have to poll manually. - The
--waitflag shows a live progress spinner. Users can press Ctrl+C to stop waiting without cancelling the job itself.