🚀 Try Zilliz Cloud, the fully managed Milvus, for free—experience 10x faster performance! Try Now>>

Milvus
Zilliz
< Docs
  • RESTful

Create Resource Group

This operation creates a resource group. A Milvus instance begins with a default resource group that includes all available query nodes. You can create additional resource groups, reassign specific query nodes from the default group, and load collections into the query nodes in these newly configured groups. This operation always succeeds no matter whether the resource group exists.

POST
/v2/vectordb/resource_groups/create
Cluster Endpoint

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

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Authorizationstringheaderrequired

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

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

The name of the resource group to create.

configobject

The configurations of the resource group to create.

requestsobject

The number of query nodes to allocate to the resource group.

node_numinteger

The number of query nodes to allocate to the resource group.

limitsobject

The maximum number of query nodes to allocate to the resource group.

node_numinteger

The maximum number of query nodes to allocate to the resource group.

transfer_fromarray

The list of source resource groups to transfer query nodes from.

[]transfer_fromobject

A source resource group to transfer query nodes from.

resource_groupstring

The name of the source resource group to transfer query nodes from.

transfer_toarray

The list of target resource groups to transfer query nodes to.

[]transfer_toobject

A target resource group to transfer query nodes to.

resource_groupstring

The name of the target resource group to transfer query nodes to.

export TOKEN="root:Milvus"


curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/resource_groups/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "name": "group1",
    "config": {
        "requests": {
            "node_num": 1
        },
        "limits": {
            "node_num": 10000
        },
        "transfer_from": [
            {
                "resource_group": "default"
            }
        ],
        "transfer_to": [
            {
                "resource_group": "default"
            }
        ]
    }
}'
Responses200 - application/json

A success response

codeinteger

Response code.

Example Value: 0
dataobject

Response payload which is an empty object.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "cost": 0,
    "data": {}
}