Skip to main content

Get Compaction State (V2)

This operation gets the state of the latest compaction task for a specified collection.

POST/v2/vectordb/collections/get_compaction_state
Connection Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes
  • You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
  • To get the endpoint, use the Describe Cluster V2 API to extract the values from the responses.
shell
export CLUSTER_ENDPOINT=""
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password. If you are using a project endpoint, only a valid API key with sufficient permissions applies.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
jobIDinteger

The ID of the compaction job.

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/get_compaction_state" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "jobID": "xxxxxxxxxxxxxxxxxxxxxx"
}'
Responses200 OK - application/json

Returns the state of the compaction task.

Response containing the compaction state.

codeinteger

Response code.

dataobject

The response payload that carries the compaction state result.

compactionIDinteger<int64>

The ID of the compaction task.

statestring

The state of the compaction task.

executingPlanNumbernumber

The number of executing plans.

timeoutPlanNumbernumber

The number of timeout plans.

completedPlanNumbernumber

The number of completed plans.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

Successjson
{
    "code": 0,
    "data": {
        "compactionID": 470224091360920600,
        "state": "Completed",
        "executingPlanNumber": 0,
        "timeoutPlanNumber": 0,
        "completedPlanNumber": 5
    }
}
Ctrl I