Skip to main content

Get Collection Load State (V2)

This operation returns the load status of a specific collection.

POST
/v2/vectordb/collections/get_load_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
dbNamestring

The name of the database which the collection belongs to. Setting this to a non-existing database results in an error.

collectionNamestringrequired

The name of the target collection. Setting this to a non-existing collection results in an error.

partitionNamesarray

A list of partition names. If any partition names are specified, releasing any of these partitions results in the return of a NotLoad state.

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/get_load_state" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "quick_setup"
}'
Responses200 - application/json
codeinteger

Response code.

Example Value: 0
dataobject

A LoadState object that indicates the load status and load progress of the specified collection.

loadStatestring

An object that indicates the load status of the specified collection.

loadProgressinteger

An integer that indicates the load progress in the percentage of the specified collection.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "loadProgress": 100,
        "loadState": "LoadStateLoaded",
        "message": ""
    }
}