Skip to content
MilvusNode SDK
Sections

Describe segments

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/segments/describe

{
  "dbName": "default",
  "collectionID": 123456789,
  "segmentIDs": [
    123456791
  ]
}

Example response

{
  "code": 0,
  "data": {
    "segmentInfos": [
      {
        "segmentID": 123456791,
        "collectionID": 123456789,
        "partitionID": 123456790,
        "vChannel": "by-dev-rootcoord-dml_0_123456789v0",
        "numRows": 1,
        "state": 4,
        "level": 2,
        "isSorted": true,
        "insertLogs": [
          {
            "fieldID": 100,
            "logIDs": [
              123456792
            ]
          }
        ],
        "deltaLogs": [],
        "statsLogs": [
          {
            "fieldID": 100,
            "logIDs": [
              123456793
            ]
          }
        ]
      }
    ]
  }
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/segments/describe' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "collectionID": 123456789,
  "segmentIDs": [
    123456791
  ]
}'

Inspect segment information for a collection ID or specific segment IDs.

Request fields

dbName string
Database name. Operations on collections use default when omitted.
collectionID integer
Internal collection ID from the collection description.
segmentIDs array of integer
List of internal segment IDs.

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