milvus-logo
LFAI
< Docs
  • RESTful

Get Collection Load State

POST
http://${MILVUS_URI}/v2/vectordb/collections/get_load_state

This operation returns the load status of a specific collection.

Example

curl --location --request POST "http://${MILVUS_URI}/v2/vectordb/collections/get_load_state" \
--header "Content-Type: application/json" \
--data-raw '{
    "collectionName": "quick_setup"
}'

Possible response is similar to the following :

{
    "code": 200,
    "data": {
        "loadProgress": 100,
        "loadState": "LoadStateLoaded"
    }
}

Request

Parameters

  • Header parameters

    ParameterDescription
    Request-Timeoutinteger
    The timeout duration for this operation. Setting this to None indicates that this operation times out when any response returns or an error occurs.
    Authorizationstring
  • No query parameters required

  • No path parameters required

Request Body

{
    "dbName": "string",
    "collectionName": "string",
    "partitionNames": "string"
}
ParameterDescription
dbNamestring
The name of a database to which the collection belongs.
collectionName *string
The name of a collection.
partitionNamesstring
A list of partition names. If any partition names are specified, releasing any of these partitions results in the return of a NotLoad state.

Response

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

Response Bodies

  • Response body if we process your request successfully
{
    "code": "integer",
    "data": {
        "loadState": "string",
        "loadProgress": "integer"
    }
}
  • Response body if we failed to process your request
{
    "code": integer,
    "message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 200: The request succeeds.
  • Others: Some error occurs.
dataobject
data.loadStatestring
An object that indicates the load status of the specified collection.
data.loadProgressinteger
An integer that indicates the load progress in the percentage of the specified collection.
messagestring
Indicates the possible reason for the reported error.