Use GetNodeConfig to obtain node configuration - OpenSearch

Operation description

method

GET

URI

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:GetNodeConfig

get

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****

Request parameters

Parameter	Type	Required	Description	Example
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

RequestExample

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

Response elements

Element	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.	1
dataDuplicateNumber	integer	The number of data replicas.	1
minServicePercent	integer	The minimum service ratio.	50
published	boolean	Indicates whether the cluster is mounted.	true
active	boolean	Indicates whether the index is effective online.	true
flowRatio	integer	The traffic percentage.	100

ResponseExample

Correct response

{

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

  "result": {

    "dataFragmentNumber":1,

    "dataDuplicateNumber":1,

    "minServicePercent":20,

    "published":true,

    "active": true  // Whether it takes effect online

  }

}

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.