調用RecommendTemplates,獲取推薦的集群配置。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數文檔。

請求語法

GET /openapi/instances/[InstanceId]/recommended-templates HTTP/1.1

請求參數

名稱 類型 位置 是否必選 示例值 描述
InstanceId String Path es-cn-oew20apwz0007****

集群ID。

usageScenario String Query general

集群使用的場景化模板類型。可選值:

  • general:通用場景
  • analysisVisualization:數據分析場景
  • dbAcceleration:數據庫加速場景
  • search:搜索場景
  • log:日志場景
說明 商業版實例支持通用場景、數據分析場景、數據庫加速場景和搜索場景;日志增強版僅支持日志場景。

返回數據

名稱 類型 示例值 描述
RequestId String 66B060CF-7381-49C7-9B89-7757927FDA16

請求ID。

Result Array of TemplateConfig

返回結果。

content String {\n\t\"persistent\": {\n\t\t\"search\": {\n\t\t\t\"max_buckets\": \"10000\"\n\t\t}\n\t}\n}

模板配置內容。

templateName String dynamicSettings

模板名稱。支持:

  • staticSettings:集群靜態配置
  • dynamicSettings:集群動態配置
  • indexTemplate:索引模板配置
  • ilmPolicy:索引生命周期配置
說明 6.7.0及以上版本的日志增強版實例,支持啟用索引生命周期模板。

示例

請求示例

GET /openapi/instances/es-cn-oew20apwz0007****/recommended-templates?usageScenario=general HTTP/1.1
公共請求頭

正常返回示例

JSON格式

{
	"Result": [
		{
			"content": "",
			"templateName": "staticSettings"
		},
		{
			"content": "",
			"templateName": "ilmPolicy"
		},
		{
			"content": "{\n\t\"order\": -2147483647,\n\t\"index_patterns\": [\n\t\t\"*\"\n\t],\n\t\"settings\": {...}.....}",
			"templateName": "indexTemplate"
		},
		{
			"content": "{\n\t\"persistent\": {\n\t\t\"search\": {\n\t\t\t\"max_buckets\": \"10000\"\n\t\t}\n\t}\n}",
			"templateName": "dynamicSettings"
		}
	],
	"RequestId": "66B060CF-7381-49C7-9B89-7757927FDA16"
}

錯誤碼

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