Help Center/ Cloud Search Service/ API Reference (Ankara Region)/ Cluster Management/ Changing the Specifications of a Specified Node Type
Updated on 2024-12-02 GMT+08:00

Changing the Specifications of a Specified Node Type

Function

This API is used to change the specifications of a specified node type. The following node types are supported:

  • ess: data node
  • ess-cold: cold data node
  • ess-client: client node
  • ess-master: master node

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/{types}/flavor

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

cluster_id

Yes

String

ID of the cluster whose specifications you want to change.

types

Yes

String

Type of the cluster node you want to modify.

  • ess: data node
  • ess-cold: cold data node
  • ess-client: client node
  • ess-master: Master node

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

newFlavorId

Yes

String

This parameter is obtained by calling the Obtaining the Instance Specifications List API. The API compares the values of the name attribute and obtains an appropriate flavor.

The old and new node specifications must be under the same Elasticsearch engine version.

needCheckReplica

No

Boolean

Whether to verify replicas. The value can be true or false. The default value is true.

  • true: Replica verification is enabled.
  • false: Replica verification is disabled.
NOTE:

Master and client nodes are not data nodes, so they do not need to check replicas no matter this parameter is set to true or false.

needCheckClusterStatus

No

Boolean

Whether to check the cluster status. The value can be true or false. The default value is true.

  • true: Cluster status verification is enabled.
  • false: Cluster status verification is ignored.

Response Parameters

None

Example Requests

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ess/flavor

{
  "needCheckReplica" : false,
  "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2",
  "needCheckClusterStatus" : true
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request before retry.

409

The request could not be completed due to a conflict with the current state of the resource.

The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

412

The server does not meet one of the preconditions that the requester puts on the request.

Error Codes

See Error Codes.