[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

Modify Cluster (V2)

Modify a dedicated cluster. You can increase or reduce the number of CUs allocated to the cluster.

POST

/v2/clusters/{CLUSTER_ID}/modify

Base URL

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

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

export BASE_URL="https://api.cloud.zilliz.com"

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}

Acceptstringheader

Use application/json.

Example Value: application/json

CLUSTER_IDstringpathrequired

ID of the cluster to modify.

Example Value: inxx-xxxxxxxxxxxxxxx

Request Bodyapplication/json

cuSizeinteger

Number of CUs allocated to this cluster after the modification. This parameter and autoscaling.cu are mutually exclusive; you can specify only one of them. The product of this parameter should not exceed 256.

Value Range: > 1≤ 256

autoscalingobject

Auto-scaling configuration for the cluster. This parameter and cuSize are mutually exclusive; you can specify only one of them.

cuobject

Auto-scaling configuration for CUs. This is unavailable if you have already set cuSize. The product of the maximum number of CUs and the maximum number of replicas should not exceed 256.

mininteger

Minimum number of CUs for auto-scaling. This parameter and schedules are mutually exclusive; you can specify only one of them.

Value Range: > 1≤ 256

maxinteger

Maximum number of CUs for auto-scaling. This parameter and schedules are mutually exclusive; you can specify only one of them.

Value Range: > 1≤ 256

schedulesarray

Auto-scaling schedules. This parameter and min/max are mutually exclusive; you can specify only one of them.

[]schedulesobject

An auto-scaling schedule.

cronstring

Cron expression defining the schedule.

Example Value: 0 0 * * *

targetinteger

Target number of CUs for this schedule.

MANUAL SCALING

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/modify" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
    "cuSize": 2
}'

DYNAMIC SCALING

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/modify" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
    "autoscaling": {
        "cu": {
            "min": 1,
            "max": 2
        }
    }
}'

SCHEDULED SCALING

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/modify" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
    "autoscaling": {
        "cu": {
            "schedules": [
                {
                    "cron": "10 0 0 0 0 ?",
                    "target": 2
                }
            ]
        }
    }
}'

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

Response payload.

clusterIdstring

ID of the cluster that has been modified.

promptstring

Prompt message returned.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "prompt": "successfully submitted. Cluster is being upgraded, which is expected to take several minutes. You can access data about the creation progress and status of your cluster by DescribeCluster API. Once the cluster status is RUNNING, you may access your vector database using the SDK."
    }
}