milvus-logo
LFAI
< Docs
  • RESTful
    • v2

List Partitions

This operation lists all partitions in the database used in the current connection.

POST
/v2/vectordb/partitions/list
Cluster Endpoint

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

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Request-Timeoutintegerheader

The timeout duration for this operation. Setting this to None indicates that this operation times out when any response returns or an error occurs.

Example Value: 0
Authorizationstringheaderrequired

The authentication token should be a pair of colon-joined username and password, like username:password.

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

The name of the target database.

collectionNamestringrequired

The name of the target collection to which the partition belongs.

export TOKEN="root:Milvus"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/partitions/list" \
--header "Request-Timeout: 0" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "quick_setup"
}'
Responses200 - application/json
codeinteger

Response code.

dataarray

A list of partition names

[]datastring

A partition name.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
"code": 0,
"data": [
"_default"
]
}