Help Center/ Cloud Search Service/ API Reference/ API V1/ Modify Configuration/ Changing Node Specifications (Discarded)
Updated on 2025-11-28 GMT+08:00

Changing Node Specifications (Discarded)

Function

This API is used to modify the node specifications of a cluster. It can only change the specifications of ess nodes (data nodes). If you need to change other types of nodes as well, use the API for Changing the Specifications of Specified Nodes.

All mission-critical data has been backed up before a disk change. This is to prevent data loss.

Calling Method

For details, see Calling APIs.

URI

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

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 whose specifications you want to change. 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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

newFlavorId

Yes

String

Definition:

ID of the new node flavor or disk type. It is determined by operationType.

Constraints:

N/A

Value range:

  • When operationType is set to vm, newFlavorId indicates the node flavor ID after the change. This parameter is obtained by calling the Obtaining the Instance Specifications List API. The API selects a flavor_id based on the values of the name attribute.

  • When operationType is set to volume, newFlavorId indicates the new disk type after the change. The following disk types are supported:

  • COMMON: common I/O

  • HIGH: high I/O

  • ULTRAHIGH: ultra-high I/O

  • ESSD: ultra-fast SSD

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

Default value:

N/A

operationType

No

String

Definition:

Operation type for specifications change.

Constraints:

N/A

Value range:

  • vm: Change the node flavor.

  • volume: Change the disk type.

Default value:

vm

needCheckReplica

No

Boolean

Definition:

Whether to check replicas when changing cluster specifications.

Constraints:

N/A

Value range:

  • *true: Enable replica verification.

  • false: Disable replica verification.

Default value:

true

needCheckClusterStatus

No

Boolean

Definition:

Whether to check the cluster status when changing cluster specifications.

Constraints:

N/A

Value range:

  • true: Enable cluster load check.

  • false: Cluster status verification is ignored.

Default value:

true

clusterLoadCheck

No

Boolean

Definition:

Whether to check the cluster load when changing cluster specifications.

Constraints:

N/A

Value range:

  • true: enable cluster load check.

  • false: Skip cluster load check.

Default value:

true

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

  • ID of the new flavor.

    POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/flavor
    
    {
      "needCheckReplica" : false,
      "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2",
      "isAutoPay" : 1,
      "needCheckClusterStatus" : true
    }
  • Change the disk type.

    POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/flavor
    
    {
      "needCheckReplica" : false,
      "newFlavorId" : "ULTRAHIGH",
      "operationType" : "volume",
      "isAutoPay" : 1,
      "clusterLoadCheck" : 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 did not meet one of the preconditions contained in the request.

Error Codes

See Error Codes.