Skip to main content

Modify Cluster

Modify the configuration of a specified cluster. Currently, you can use this API to change the size of the CU associated with your cluster.


POST
https://controller.api.{cloud-region}.zillizcloud.com/v1/clusters/{clusterId}/modify

Example

Notes
  • This API requires an API Key as the authentication token.
curl --request POST \
--url "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/clusters/${clusterId}/modify" \
--header "Authorization: Bearer ${API_KEY}" \
--header "accept: application/json" \
--header "content-type: application/json" \
--data-raw '{
"cuSize": 2
}'

Success response:

{
"code": 200,
"data": {
"clusterId": "in01-***************",
"prompt": "Submission successful, Cluster is currently upgrading and will take several minutes, you can use the DescribeCluster interface to obtain the creation progress and the status of the Cluster. When the Cluster status is RUNNING, you can access your vector database using the SDK."
}
}

Request

Parameters

  • No query parameters required

  • Path parameters

    ParameterDescription
    clusterIdstring(required)
    The ID of a cluster to which this operation applies.

Request Body

{
"cuSize": "integer"
}
ParameterDescription
cuSizeinteger
The size of the CU to be associated to your cluster after the configuration.

Response

Returns the ID of the affected cluster.

Response Bodies

  • Response body if we process your request successfully
{
"code": "integer",
"data": {
"clusterId": "string",
"prompt": "string"
}
}
  • 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
dataobject
data.clusterIdstring
The ID of a cluster.
data.promptstring
The statement indicating that the current operation succeeds.
messagestring
Indicates the possible reason for the reported error.

Possible Errors

CodeError Message
80006Invalid cuSize. The parameter value should be one of [1
80014Invalid projectId. The projectId should like proj-xxxxxx
80021Serverless cluster not support this operation.