查看 Compaction 状态 (V2)

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

POST/v2/vectordb/collections/get_compaction_state

连接端点

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明

你需要填入您的 Zilliz Cloud 集群的 ${CLUSTER_ENDPOINT}。
您可以使用查看集群详情 V2 来获取集群的 Endpoint.

export CLUSTER_ENDPOINT=""

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。如果您使用的是项目端点，则仅具备足够权限的有效 API 密钥适用。

示例值：Bearer {{TOKEN}}

请求体application/json

jobIDinteger

Compaction 任务的 ID。

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"
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

compactionIDstring

Compaction 任务的 ID。

statestring

Compaction 任务的状态。

executingPlanNumbernumber

正在执行的计划数。

timeoutPlanNumbernumber

超时计划数。

completedPlanNumbernumber

已完成的计划数。

FAILURE

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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