調(diào)用UpdateILMPolicy，修改索引生命周期策略。

調(diào)試

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

請(qǐng)求頭

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

請(qǐng)求語(yǔ)法

PUT /openapi/instances/[InstanceId]/ilm-policies/[PolicyName] HTTP/1.1

請(qǐng)求參數(shù)

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

實(shí)例ID。
PolicyName String Path 是 my-policy

索引生命周期策略名稱。
ClientToken String Query 否 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保證請(qǐng)求的冪等性。由客戶端生成該參數(shù)值，要保證在不同請(qǐng)求間唯一，最大不超過(guò)64個(gè)ASCII字符。

RequestBody

參數(shù)

類型

示例值

是否必選

描述

name

String

my-policy

是

索引生命周期策略名稱。

phases

Map

否

索引生命周期策略內(nèi)容。詳情請(qǐng)參見phases字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明。

phases字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

類型

示例值

是否必選

描述

{key}

Struct

否

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

minAge

String

30d

否

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

actions

Struct

否

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

actions字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

類型

示例值

是否必選

描述

rollver

Struct

否

hot階段的索引滾動(dòng)更新操作。詳情請(qǐng)參見rollver字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明。

setPriority

Struct

否

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

allocate

Struct

否

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

delete

Struct

{}

否

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

參數(shù)

類型

示例值

是否必選

描述

maxAge

String

30d

否

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

maxDocs

Integer

10000

否

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

maxSize

String

50gb

否

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

參數(shù)

類型

示例值

是否必選

描述

priority

Integer

100

否

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

參數(shù)

類型

示例值

是否必選

描述

numberOfReplicas

Integer

1

否

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

require

Struct

否

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

require字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

類型

示例值

是否必選

描述

boxType

String

warm

否

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

返回?cái)?shù)據(jù)

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

請(qǐng)求ID。
Result String my-policy

返回結(jié)果。

示例

請(qǐng)求示例

PUT /openapi/instances/es-cn-nif24adwc0082w2ka****/ilm-policies/my-policy HTTP/1.1
公共請(qǐng)求頭
{
    "name": "my-policy",
    "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": {}
            }
        }
    }
}

正常返回示例

JSON格式 

{
    "RequestId": "F99407AB-2FA9-489E-A259-40CF6DCC****",
    "Result": "my-policy"
}

錯(cuò)誤碼

訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。