Skip to content
MilvusNode SDK
Sections

Describe restore job

Markdown

Copy for agent

Connection and CORS help

Use HTTPS for remote clusters or HTTP on loopback. Requests go directly from your browser to the endpoint. When copying an authenticated cURL command, set MILVUS_TOKEN in your shell.

For cross-origin requests, configure the endpoint to answer OPTIONS and allow the docs origin, POST, Content-Type, and Authorization if you use a token. Try the copied cURL command to troubleshoot outside the browser.

POST/v2/vectordb/jobs/snapshot/describe

{
  "jobId": "123456789"
}

Example response

{
  "code": 0,
  "data": {
    "jobId": 123456789,
    "snapshotName": "books_backup",
    "dbName": "default",
    "collectionName": "books_restored",
    "progress": 100,
    "reason": "",
    "startTime": 1795099200000,
    "timeCost": 2000,
    "state": "RestoreSnapshotCompleted"
  }
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/jobs/snapshot/describe' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "jobId": "123456789"
}'

Read the state of a snapshot restore job.

Request fields

jobId string (required)
Job ID returned when the job was submitted.

See HttpClient.getRestoreSnapshotState for the Node.js SDK method.