ListDefaultCollectorConfigurations - Elasticsearch

調試

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

要求標頭

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

請求文法

GET /openapi/beats/default-configurations HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
resType	String	Query	是	fileBeat	採集器類型。可選值： fileBeat metricBeat heartBeat auditBeat
resVersion	String	Query	是	6.8.5_with_community	採集器版本。採集器部署的機器類型不同，可選的版本也不同，具體說明如下： ECS：6.8.5_with_community ACK：6.8.13_with_community
sourceType	String	Query	否	ECS	指定採集器部署機器的類型，不填則返回全部。可選值： ECS：ECS伺服器 ACK：容器Kubernetes叢集

返回資料

名稱	類型	樣本值	描述
RequestId	String	8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5	請求ID。
Result	Array of Result		返回結果。
content	String	- key: log\n title: Log file content\n description: >\n Contains log file lines.\n fields:\n ......	設定檔內容。
fileName	String	fields.yml	設定檔名稱。

樣本

請求樣本

GET /openapi/beats/default-configurations?resVersion=6.8.5_with_community&resType=fileBeat&sourceType=ECS HTTP/1.1
公用要求標頭

正常返回樣本

JSON格式

{
	"Result": [
		{
			"fileName": "fields.yml",
			"content": "- key: log\n  title: Log file content\n  description: >\n    Contains log file lines.\n  fields:\n ......"
		},
		{
			"fileName": "filebeat.yml",
			"content": "###################### Filebeat Configuration Example #########################\n\n# This file is an example configuration file ......"
		}
	],
	"RequestId": "8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5"
}

錯誤碼

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