調(diào)用ListILMPolicies，查詢已有的索引生命周期策略列表。

調(diào)試

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

請求頭

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

請求語法

GET /openapi/instances/{InstanceId}/ilm-policies HTTP/1.1

請求參數(shù)

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

實例ID。
policyName String Query 否 policy-1

索引生命周期策略名稱。

返回數(shù)據(jù)

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

請求ID。
Result Array of Result

請求返回的索引生命周期策略列表。
name String policy-1

索引生命周期策略名稱。
phases Map

索引生命周期內(nèi)容。
phases字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

類型

示例值

是否必選

描述

{key}

Struct

否

當(dāng)前生命周期階段，支持以下三種階段：hot（熱數(shù)據(jù)階段，正在積極更新和查詢索引）；cold（冷數(shù)據(jù)階段，索引不再被更新并且很少被查詢。信息仍然需要可搜索，但是如果這些查詢速度較慢也可以。）；delete（刪除階段，不再需要該索引，可以安全地將其刪除）。

minAge

String

30d

否

索引到達(dá)目標(biāo)階段所需要的時間。

actions

Struct

否

當(dāng)前階段策略設(shè)置。詳情請參見下方的actions字段數(shù)據(jù)結(jié)構(gòu)說明。
actions字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

類型

示例值

是否必選

描述

rollover

Struct

否

hot階段的索引滾動更新操作。詳情請參見下方的rollover字段數(shù)據(jù)結(jié)構(gòu)說明。

setPriority

Struct

否

hot或cold階段的索引優(yōu)先級。詳情請參見下方的setPriority字段數(shù)據(jù)結(jié)構(gòu)說明。

allocate

Struct

否

cold階段的分配操作。詳情請參見下方的allocate字段數(shù)據(jù)結(jié)構(gòu)說明。

delete

Struct

{}

否

刪除索引操作。delete階段開啟時，屬性必傳，為空對象。
rollover字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

類型

示例值

是否必選

描述

maxAge

String

30d

否

觸發(fā)滾動索引所需要的時間閾值。maxAge、maxDocs和maxSize三者中至少選填一個。單位：d（天）或者h(yuǎn)（小時）。

maxDocs

Integer

10000

否

觸發(fā)滾動索引所需要的文檔數(shù)量的閾值。

maxSize

String

50gb

否

觸發(fā)滾動索引所需要的索引大小的閾值。maxAge、maxDocs和maxSize三者中至少選填一個。單位：MB或者GB。
setPriority字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

類型

示例值

是否必選

描述

priority

Integer

100

否

當(dāng)前節(jié)點(diǎn)默認(rèn)的優(yōu)先級。
allocate字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

類型

示例值

是否必選

描述

numberOfReplicas

Integer

1

否

分配指定的副本數(shù)，如果設(shè)置，則默認(rèn)值為1。與migrate配合使用，開啟自動遷移時，默認(rèn)進(jìn)行副本數(shù)分配。

require

Struct

否

可選設(shè)置，冷熱分離架構(gòu)集群可用。詳情請參見下方的require字段數(shù)據(jù)結(jié)構(gòu)說明。
require字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

類型

示例值

是否必選

描述

boxType

String

warm

否

自定義節(jié)點(diǎn)屬性標(biāo)識，冷熱分離架構(gòu)集群可用，遷移至冷節(jié)點(diǎn)。可選值：warm。

示例

請求示例

GET /openapi/instances/es-cn-m7r23wodb006n****/ilm-policies HTTP/1.1
公共請求頭

正常返回示例

JSON格式

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

{
  "RequestId" : "FF44681E-FD41-4FDE-B8DF-295DCDD6****",
  "Result" : [ {
    "name" : "policy-1",
    "phases" : {
      "cold" : {
        "minAge" : "30d",
        "actions" : {
          "allocate" : {
            "numberOfReplicas" : 1,
            "require" : {
              "boxType" : "warm"
            }
          },
          "setPriority" : {
            "priority" : 100
          }
        }
      },
      "hot" : {
        "minAge" : "0s",
        "actions" : {
          "rollover" : {
            "maxAge" : "30d",
            "maxDocs" : 10000,
            "maxSize" : "50gb"
          },
          "setPriority" : {
            "priority" : 1000
          }
        }
      },
      "delete" : {
        "minAge" : "30d",
        "actions" : {
          "delete" : { }
        }
      }
    }
  } ]
}

錯誤碼

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