Help Center/ Cloud Search Service/ API Reference/ APIs/ Cluster Management/ Changing the Specifications of a Specified Node Type

Updated on 2024-10-17 GMT+08:00

View PDF

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
lgs: Lgs node.

Debugging

You can debug this API through automatic authentication in API Explorer.

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 about how to obtain the project ID and name, see Obtaining the 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 lgs: Lgs node.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
newFlavorId	Yes	String	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. The old and new node specifications must be under the same Elasticsearch engine version. 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
operationType	No	String	Operation type. The value can be vm or volume. The default value is vm. vm: Change the node flavor. volume: Change the disk type.
needCheckReplica	No	Boolean	Indicates whether to verify replicas. Its value can be true or false. This function is enabled by default. *true: Enable the replicas verification. false: Disable the replicas verification. 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.
isAutoPay	No	Integer	Indicates whether to enable automatic payment from your Huawei Cloud account. This parameter takes effect only for yearly/monthly clusters. 1: Yes. (Discounts and coupons are automatically selected. The fee will be automatically deducted from your Huawei Cloud account.) If the automatic payment fails, an unpaid order will be generated, and you need to manually complete the payment. (During manual payment, you can still modify the discounts and coupons that were automatically selected.) 0: No. (The customer needs to manually pay for the bill. Discounts and coupons can be used.) The default value is 0.
needCheckClusterStatus	No	Boolean	Indicates whether to check the cluster status. The value can be true or false. This function is enabled by default. true: Cluster status verification is enabled. false: Cluster status verification is ignored.
clusterLoadCheck	No	Boolean	Whether to check the cluster load. The value can be true or false. The default value is true. true: enable cluster load check. true: skip cluster load check.

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",
  "isAutoPay" : 1,
  "needCheckClusterStatus" : true
}

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ess/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.