全部產品
Search
文件中心

Elasticsearch:UpdateXpackMonitorConfig

更新時間:Jan 16, 2025

調用UpdateXpackMonitorConfig,更新Logstash執行個體的X-Pack監控警示配置。

調試

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

要求標頭

該介面使用公用要求標頭,無特殊要求標頭。請參見公用請求參數文檔。

請求文法

POST /openapi/logstashes/{InstanceId}/xpack-monitor-config HTTP/1.1

請求參數

名稱 類型 位置 是否必選 樣本值 描述
InstanceId String Path ls-cn-oew1qbgl****

Logstash執行個體ID。

ClientToken String Query 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用於保證請求的等冪性。由用戶端產生該參數值,要保證在不同請求間唯一,最大不超過64個ASCII字元。

Object Body

X-Pack監控的配置資訊。

enable Boolean Body true

是否開啟X-Pack監控:

  • true:開啟
  • false:不開啟
endpoints Array of String Body http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200

Elasticsearch執行個體的訪問地址。

userName String Body elastic

Elasticsearch執行個體的使用者名稱。

password String Body ******

Elasticsearch執行個體的密碼。

返回資料

名稱 類型 樣本值 描述
Result Boolean true

返回結果:

  • true:更新成功
  • false:更新失敗
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

請求ID。

樣本

請求樣本

POST /openapi/logstashes/ls-cn-oew1qbgl****/xpack-monitor-config?ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "enable" : true,
  "endpoints" : [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ],
  "userName" : "elastic",
  "password" : "******"
}

正常返回樣本

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "30A59FC7-609B-4C12-B6EF-991A5CA7****"
}

錯誤碼

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