ModifyNodeConfig - OpenSearch - Alibaba Cloud Documentation Center

Modifies the configurations of a node.

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

PUT /openapi/ha3/instances/{instanceId}/node-config

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-2r42p5oi202
type	string	Yes	The type of the algorithm. Valid values: pop: a popularity model. cp: a category prediction model. hot: a top search model. hint: a hint model. suggest: a drop-down suggestions model.	" "
name	string	Yes	The name of the configuration before the modification.	ha-cn-zvp2iv9a401_qrs
clusterName	string	No	The name of the cluster.	vpc_sh_domain_2
dataSourceName	string	No	The name of the data source. Valid values: -search: search for data. -not_search: do not search for data.	ha-cn-2r42ostoc01_0704
body	object	No	The request body.
dataFragmentNumber	integer	No	The number of data shards.	1
dataDuplicateNumber	integer	No	The number of data replicas.	1
minServicePercent	integer	No	The minimum service ratio.	10
published	boolean	No	Specifies whether to mount the cluster.	true
active	boolean	No	Specifies whether to enable the index.	true
flowRatio	integer	No	The traffic percentage.	-100

Sample requests

PUT /openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test

{

  "dataFragmentNumber":1,// The query node and data node

  "dataDuplicateNumber":1,// The query node and data node

  "minServicePercent":20,// The query node and data node

  "published":true,// The cluster

  "active": true //index

}

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	id of request	D39EE0F1-D7EF-5F46-B781-6BF4185308B0
result	object	The information about the index	{}

Sample responses

Success responses

{

  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",

  "result": []

}

For more information, see Response struct.

Examples

Sample success responses

JSONformat

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
  "result": {}
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-03-20	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-08-28	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2022-01-12	Add Operation	View Change Details