All Products
Search
Document Center

OpenSearch:GetNodeConfig

Last Updated:Oct 16, 2024

Gets the configuration information of a node.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
searchengine:GetNodeConfigget
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-0ju2rewdi02
typestringNo

The node type. Valid values:

  • qrs: Query Result Searcher (QRS) worker
  • search: Search worker
  • index: index
  • cluster: cluster
index
namestringNo

The node name.

ha-cn-30174dhoz53_qrs
clusterNamestringNo

The name of the cluster

vpc_sh_domain_2

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

requestIdstring

Id of the request

2AE63638-5420-56DC-BF59-37D8174039A0
resultobject

The result set.

dataFragmentNumberinteger

The number of data shards.

2
dataDuplicateNumberinteger

The number of data replicas.

2
minServicePercentinteger

The minimum service ratio.

100
publishedboolean

Indicates whether the cluster is mounted.

true
activeboolean

Indicates whether the index is effective online.

1
flowRatiointeger

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 timeSummary of changesOperation
2024-03-20The response structure of the API has changedView Change Details
2023-08-28The request parameters of the API has changed. The response structure of the API has changedView Change Details
2022-01-12Add OperationView Change Details