Help Center/ Cloud Search Service/ API Reference/ API V1/ Modify Configuration/ Adding Dedicated Master or Client Nodes or Cold Data Nodes
Updated on 2025-11-28 GMT+08:00
View PDF

Adding Dedicated Master or Client Nodes or Cold Data Nodes

Function

This API is used to add dedicated master or client nodes or cold data nodes to an existing cluster that previously does not have such nodes. (When planning a cluster, you cannot always accurately predict future changes in data volumes. Add dedicated master or client nodes or cold data nodes is an effective way to scale up a cluster.)

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independent

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints:

N/A

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the cluster that requires dedicated master or client nodes or cold data nodes. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

type

Yes

String

Definition:

Types of dedicated nodes to add.

Constraints:

N/A

Value range:

  • ess-master: master node

  • ess-client: client node

  • ess-cold: cold data node

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

type

Yes

IndependentTypeReq object

Definition:

Request body parameters for dedicated master, client, or cold data nodes.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 3 IndependentTypeReq

Parameter

Mandatory

Type

Description

flavor_ref

Yes

String

Definition:

Flavor ID.

Constraints:

N/A

Value range:

You can obtain the value of this parameter by calling the API for Obtaining the Instance Specifications List. Select the flavor ID suitable for your cluster version.

Default value:

N/A

node_size

Yes

Integer

Definition:

Number of dedicated nodes.

Constraints:

N/A

Value range:

  • If the node type is ess-master, the number of nodes must be an odd number in the range 3 to 9.

  • If the node type is ess-client, the number of nodes must be in the range 1 to 64.

  • If the node type is ess-cold, indicating to add dedicated cold data nodes, the number of nodes must be in the range 1 to 32.

Default value:

N/A

volume_type

No

String

Definition:

Node storage type.

Constraints:

This parameter cannot be set when flavor_ref is set to a local disk flavor.

Value range:

  • COMMON: common I/O

  • HIGH: high I/O

  • ULTRAHIGH: ultra-high I/O

  • ESSD: ultra-fast SSD

Default value:

If flavor_ref is not set to a local disk flavor, the default value is ULTRAHIGH.

volume_size

No

Integer

Definition:

Node storage capacity.

Constraints:

  • This parameter cannot be set when flavor_ref is set to a local disk flavor.

  • The value must be greater than 0 and a common multiple of 4 and 10, in GB.

  • Adding dedicated cold data nodes: 100 GB or the minimum disk capacity supported by the selected node flavor, whichever is larger.

  • Adding dedicated master or client nodes: The default size is 40 GB and cannot be changed.

Value range:

You can obtain the disk size from the diskrange attribute in Obtaining the Instance Specifications List.

Default value:

If flavor_ref is not set to a local disk flavor:

NOTE:
Adding dedicated cold data nodes: The disk size should be greater than 100 GB.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Definition:

Cluster ID.

Value range:

N/A

Example Requests

Add dedicated master or client nodes or cold data nodes.

POST https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent

{
  "type" : {
    "flavor_ref" : "d9dc06ae-b9c4-4ef4-acd8-953ef4205e27",
    "node_size" : 3,
    "volume_type" : "COMMON",
    "volume_size" : 40
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "320afa24-ff2a-4f44-8460-6ba95e512ad4"
}

Status Codes

Status Code

Description

200

Request succeeded.

403

Request rejected.

The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

500

The server has received the request but could not understand it.

Error Codes

See Error Codes.

Parent topic: Modify Configuration