Changing the Specifications of a Specified Node Type

Function

This API is used to modify cluster specifications. The following node types can be changed:

  • ess: data node

  • ess-cold: cold data node

  • ess-client: client node

  • ess-master: master node

URI

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

Table 1 Path Parameters

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 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

needCheckReplica

No

Boolean

Whether to check replicas. The value can be true or false. The check is enabled by default.

  • true: Replicas are checked.

  • false: Replicas are not checked.

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.

newFlavorId

Yes

String

ID of the new flavor. This parameter is obtained by calling the Obtaining the List of Instance Flavors API. The API compares the values of the name attribute and obtains the ID of the flavor higher than the current flavor. Only the node specifications of the same Elasticsearch engine version can be changed.

Response Parameters

None

Example Requests

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

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 did not meet one of the preconditions contained in the request.