調用ListComponentIndices，獲取Elasticsearch的組合模板列表。

詳細信息請參見通過OpenStore實現海量數據存儲。

調試

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

請求頭

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

請求語法

GET /openapi/instances/{InstanceId}/component-index HTTP/1.1

請求參數

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

實例ID。
name String Query 否 template

組合模板名稱。
page Integer Query 否 5

分頁查詢時設置的頁數。默認值：1。
size Integer Query 否 10

分頁查詢時設置的每頁條數。默認值：10。

返回數據

名稱 類型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC47D9

請求ID。
Headers Object

返回頭信息。
X-Total-Count Long 10

返回結果條數。
Result Array of Result

返回結果詳情。
composed Array of String ["template1", "template2"]

引用該組合模板的索引模板名構成的數組。
content Object

組合模板內容。
template Object

組合模版對象。
settings Object

模板settings配置。
index Object

索引信息。
codec String best_compression

索引壓縮方法。支持：

  • LZ4：Elasticsearch的默認壓縮算法，解壓或壓縮效率很快，但壓縮率較低一些。
  • best_compression：使用best_compression算法進行壓縮，具有更高的壓縮率。
lifecycle Object

索引生命周期配置。
name String synthetics

生命周期策略名稱。
version Long 0

組合模板的版本。
_meta Map

元數據，用于存儲備注等信息。
name String synthetics-settings

組合模板名稱。

示例

請求示例

GET /openapi/instances/es-cn-tl329rbpc0001****/component-index?name=template&page=5&size=10 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回示例

JSON格式 

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

{
  "Result" : [ {
    "composed" : [ "xxx", "xddd" ],
    "name" : "synthetics-settings",
    "content" : {
      "template" : {
        "settings" : {
          "index" : {
            "lifecycle" : {
              "name" : "synthetics"
            },
            "codec" : "best_compression"
          }
        }
      },
      "_meta" : {
        "managed" : true,
        "description" : "default settings for the synthetics index template installed by x-pack"
      },
      "version" : 0
    }
  } ],
  "RequestId" : "4405A990-49AC-46A1-9960-FA4FAEE4A425",
  "Headers" : {
    "X-Total-Count" : 7
  }
}

錯誤碼

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