GetNodeConfig - OpenSearch - Alibaba Cloud Documentation Center

Gets the configuration information of a node.

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

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-0ju2rewdi02
type	string	No	The node type. Valid values: qrs: Query Result Searcher (QRS) worker search: Search worker index: index cluster: cluster	index
name	string	No	The node name.	ha-cn-30174dhoz53_qrs
clusterName	string	No	The name of the cluster	vpc_sh_domain_2

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	Id of the request	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	The result set.
dataFragmentNumber	integer	The number of data shards.	2
dataDuplicateNumber	integer	The number of data replicas.	2
minServicePercent	integer	The minimum service ratio.	100
published	boolean	Indicates whether the cluster is mounted.	true
active	boolean	Indicates whether the index is effective online.	1
flowRatio	integer	The traffic percentage.	0

Examples

Sample success responses

JSONformat

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "dataFragmentNumber": 2,
    "dataDuplicateNumber": 2,
    "minServicePercent": 100,
    "published": true,
    "active": true,
    "flowRatio": 0
  }
}

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 response structure of the API has changed	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