Skip to content
MilvusNode SDK
Sections

Describe refresh 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/external_collection/describe

{
  "jobId": 123456789
}

Example response

{
  "code": 0,
  "data": {
    "jobId": 123456789,
    "collectionName": "books",
    "state": "RefreshCompleted",
    "progress": 100,
    "externalSource": "s3://example-bucket/books/",
    "externalSpec": "{\"format\":\"parquet\"}",
    "startTime": 1795099200000,
    "endTime": 1795099202000
  }
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/jobs/external_collection/describe' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "jobId": 123456789
}'

Inspect refresh progress using the unquoted integer job ID returned at submission.

Request fields

jobId integer (required)
Unquoted int64 job ID. Paste the exact digits returned by the refresh request.

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