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

Cluster 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.

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.

Example Value: Bearer {{TOKEN}}

Request Bodyapplication/json

jobIDstring

The ID of the compaction job.

export TOKEN="db_admin:xxxxxxxxxxxxx"

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

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

compactionIDstring

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.

completePlanNumbernumber

The number of completed plans.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "compactionID": "xxxxxxxxxxxxxxxxxxxxxx",
        "state": "Completed",
        "executingPlanNumber": 0,
        "timeoutPlanNumber": 0,
        "completePlanNumber": 5
    }
}