Scaling Out a Cluster with only Common Nodes¶

Function¶

This API is used to scale out a cluster with only common nodes. Clusters with master, client, or cold data nodes cannot use this API.

URI¶

POST /v1.0/{project_id}/clusters/{cluster_id}/extend

**Table 1** Parameter description¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.
cluster_id	Yes	String	ID of the cluster to be scaled out.

Request¶

Table 2 describes the request parameters.

**Table 2** Parameter description¶
Parameter	Mandatory	Type	Description
grow	Yes	Object	Detailed description about the cluster scale-out request. For details, see Table 3.

**Table 3** **grow** field description¶
Parameter	Mandatory	Type	Description
modifySize	Yes	Integer	Number of instances in a cluster after a scale-out. Note The total number of existing instances and newly added instances in a cluster cannot exceed 32.

Response¶

None

Examples¶

Example request

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/extend
{
    "grow":
        {
            "modifySize": 4
        }
}

Example response

{}

Status Code¶

Table 4 describes the status code.

**Table 4** Status codes¶
Status Code	Message	Description
400	BadRequest	Invalid request. Modify the request instead of retrying.
404	NotFound	The requested resource cannot be found. Modify the request instead of retrying.
200	OK	The request is processed successfully.

last updated: 2024-11-13 14:01 UTC - commit: 57e9916704b2f9567fccd20431958ae350c64958