全部產品
Search
文件中心

Elasticsearch:DescribeXpackMonitorConfig

更新時間:Jan 16, 2025

調用DescribeXpackMonitorConfig,擷取Logstash執行個體的X-Pack監控配置。

調試

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

要求標頭

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

請求文法

GET /openapi/logstashes/[InstanceId]/xpack-monitor-config HTTP/1.1

請求參數

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

Logstash執行個體ID。

返回資料

名稱 類型 樣本值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

請求ID。

Result Struct

返回結果。

enable Boolean true

是否開啟X-Pack監控:

  • true:開啟
  • false:未開啟
endpoints List ["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]

X-Pack監控關聯的Elasticsearch執行個體的訪問地址清單。

esInstanceId String es-cn-n6w1o1x0w001c****

X-Pack監控關聯的Elasticsearch執行個體ID。

pipelineIds List []

X-Pack監控關聯的Kibana執行個體管理的管道列表。

userName String elastic

X-Pack監控關聯的Elasticsearch執行個體的訪問使用者名稱。

樣本

請求樣本

GET /openapi/logstashes/ls-cn-oew1qbgl****/xpack-monitor-config HTTP/1.1
公用要求標頭

正常返回樣本

JSON格式

{
	"Result": {
		"esInstanceId": "es-cn-n6w1o1x0w001c****",
		"endpoints": [
			"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
		],
		"pipelineIds": [],
		"userName": "elastic",
		"enable": true
	},
	"RequestId": "9EC7377A-60D7-4AB2-ADE3-983E1D0D****"
}

錯誤碼

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