使用GetNodeConfig擷取節點配置資訊-智能OpenSearch OpenSearch-阿里雲 - OpenSearch

介面說明

方法

GET

URI

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

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:GetNodeConfig

get

*Instance

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

無

請求文法

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

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID。	ha-cn-pl32rf0****

請求參數

名稱	類型	必填	描述	樣本值
type	string	否	節點類型 qrs：查詢節點 search：資料節點 index：索引節點 cluster：叢集。	index
name	string	否	節點名稱。	ha-cn-30174dhoz53_qrs
clusterName	string	否	叢集名稱。	vpc_sh_domain_2

請求示例

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

返回參數

名稱	類型	描述	樣本值
	object
requestId	string	請求 ID。	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	返回結果。
dataFragmentNumber	integer	資料分片數。	1
dataDuplicateNumber	integer	資料副本數。	1
minServicePercent	integer	最小服務比例。	50
published	boolean	叢集是否掛載。	true
active	boolean	線上生效（索引是否從線上下掉）。	true
flowRatio	integer	流量比例。	100

返回示例

正確返回

{

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

  "result": {

    "dataFragmentNumber":1,

    "dataDuplicateNumber":1,

    "minServicePercent":20,

    "published":true,

    "active": true  // 線上是否生效

  }

}
```。

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。