調用DescribeIndexTemplate，查看組件索引模版詳情，包括索引生命周期。僅適用于日志增強版實例。

調試

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

請求頭

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

請求語法

GET /openapi/instances/{InstanceId}/index-templates/{IndexTemplate} HTTP/1.1

請求參數

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

實例ID。
IndexTemplate String Path 是 data-stream-default

索引模版名稱。

返回數據

名稱 類型 示例值 描述
RequestId String 25DB38F8-82E4-4D16-82BB-FF077C7F****

請求ID。
Result Object

返回索引模板詳情。
dataStream Boolean true

是否開啟數據流：

  • true：開啟
  • false：不開啟

默認值：false（不開啟）。
indexTemplate String data-stream-default

索引模版名稱。
ilmPolicy String cube_default_ilm_policy

生命周期策略名稱。
priority Integer 0

優先級。
indexPatterns Array of String ds-*

索引匹配模式正則。
template Object

組件模版。
settings String {\"index.refresh_interval\":\"1s\"}

settings設置。
mappings String {\"properties\":{\"created_at\":{\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\",\"type\":\"date\"},\"host_name\":{\"type\":\"keyword\"}}}

mappings設置。
aliases String {\"mydata\":{}}

aliases設置。

示例

請求示例

GET /openapi/instances/es-cn-n6w24n9u900am****/index-templates/data-stream-default HTTP/1.1
公共請求頭

正常返回示例

JSON格式 

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

{
  "RequestId" : "25DB38F8-82E4-4D16-82BB-FF077C7F****",
  "Result" : {
    "ilmPolicy" : "cube_default_ilm_policy",
    "dataStream" : true,
    "indexTemplate" : "data-stream-default",
    "priority" : 0,
    "indexPatterns" : "ds-*",
    "template" : {
      "settings" : "{\"index.refresh_interval\":\"1s\"}",
      "mappings" : "{\"properties\":{\"created_at\":{\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\",\"type\":\"date\"},\"host_name\":{\"type\":\"keyword\"}}}",
      "aliases" : "{\"mydata\":{}}"
    }
  }
}

錯誤碼

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