調用CreateILMPolicy，創建索引生命周期策略。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數文檔。
請求語法
POST /openapi/instances/[InstanceId]/ilm-policies HTTP/1.1請求參數
| 名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|---|
| InstanceId | String | Path | 是 | es-cn-m7r23wodb006n**** |
實例ID。 |
| ClientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
用于保證請求的冪等性。由客戶端生成該參數值，要保證在不同請求間唯一，最大不超過64個ASCII字符。 |
RequestBody
|
參數 |
類型 |
示例值 |
是否必選 |
描述 |
|---|---|---|---|---|
|
name |
String |
my-policy |
是 |
索引生命周期策略名稱。 |
|
phases |
Map |
否 |
索引生命周期策略內容。詳情請參見phases字段數據結構說明。 |
|
參數 |
類型 |
示例值 |
是否必選 |
描述 |
|---|---|---|---|---|
|
{key} |
Struct |
否 |
當前生命周期階段，支持以下三種階段：hot（熱數據階段，正在積極更新和查詢索引）；cold（冷數據階段，索引不再被更新并且很少被查詢。信息仍然需要可搜索，但是如果這些查詢速度較慢也可以。）；delete（刪除階段，不再需要該索引，可以安全地將其刪除）。 |
|
|
minAge |
String |
30d |
否 |
索引到達目標階段所需要的時間。 |
|
actions |
Struct |
否 |
當前階段策略設置。詳情請參見actions字段數據結構說明。 |
|
參數 |
類型 |
示例值 |
是否必選 |
描述 |
|---|---|---|---|---|
|
rollver |
Struct |
否 |
hot階段的索引滾動更新操作。詳情請參見rollver字段數據結構說明。 |
|
|
setPriority |
Struct |
否 |
hot或cold階段的索引優先級。詳情請參見setPriority字段數據結構說明。 |
|
|
allocate |
Struct |
否 |
cold階段的分配操作。詳情請參見allocate字段數據結構說明。 |
|
|
delete |
Struct |
{} |
否 |
刪除索引操作。delete階段開啟時，屬性必傳，為空對象。 |
|
參數 |
類型 |
示例值 |
是否必選 |
描述 |
|---|---|---|---|---|
|
maxAge |
String |
30d |
否 |
觸發滾動索引所需要的時間閾值。maxAge、maxDocs和maxSize三者中至少選填一個。單位：d（天）或者h（小時）。 |
|
maxDocs |
Integer |
10000 |
否 |
觸發滾動索引所需要的文檔數量的閾值。 |
|
maxSize |
String |
50gb |
否 |
觸發滾動索引所需要的索引大小的閾值。maxAge、maxDocs和maxSize三者中至少選填一個。單位：MB或者GB。 |
|
參數 |
類型 |
示例值 |
是否必選 |
描述 |
|---|---|---|---|---|
|
priority |
Integer |
100 |
否 |
當前節點默認的優先級。 |
|
參數 |
類型 |
示例值 |
是否必選 |
描述 |
|---|---|---|---|---|
|
numberOfReplicas |
Integer |
1 |
否 |
分配指定的副本數，如果設置，則默認值為1。與migrate配合使用，開啟自動遷移時，默認進行副本數分配。 |
|
require |
Struct |
否 |
可選設置，冷熱分離架構集群可用。詳情請參見require字段數據結構說明。 |
|
參數 |
類型 |
示例值 |
是否必選 |
描述 |
|---|---|---|---|---|
|
boxType |
String |
warm |
否 |
自定義節點屬性標識，冷熱分離架構集群可用，遷移至冷節點。可選值：warm。 |
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | F99407AB-2FA9-489E-A259-40CF6DCC**** |
請求ID。 |
| Result | String | my-policy |
請求返回的創建的生命周期的名稱。 |
示例
請求示例
POST /openapi/instances/es-cn-m7r23wodb006n****/ilm-policies HTTP/1.1
公共請求頭
{
"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"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。