調用ModifyElastictask，更新集群彈性擴縮容規則。

調試

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

請求頭

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

請求語法

POST /openapi/instances/{InstanceId}/elastic-task HTTP/1.1

請求參數

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

實例ID。
String Body 否 { "elasticExpansionTask": { "triggerType":"crontab", "cronExpression":"0 0 0 ? * MON", "elasticNodeCount":"2", "targetIndices":["*"], "replicaCount":"2" } }

指定擴縮容信息。

RequestBody

RequestBody中還需填入以下參數，用來指定擴縮容信息。

名稱

類型

是否必選

示例值

描述

elasticExpansionTask

否

彈性節點擴容規則。

└triggerType

String

是

crontab

觸發條件。可選值：crontab，表示定時觸發。

└cronExpression

String

是

0 0 0 ? * MON

觸發周期，使用Quartz Cron表達式。

└elasticNodeCount

Integer

否

2

目標高峰期彈性數據節點數量。

└targetIndices

List

否

["index"]

目標彈性索引名稱，支持通配符。

└replicaCount

String

是

2

目標索引的副本數。

elasticShrinkTask

否

彈性節點縮容規則。

└triggerType

String

是

crontab

觸發條件。可選值：crontab，表示定時觸發。

└cronExpression

String

是

4 4 4 ? * WED

觸發周期，使用Quartz Cron表達式。

└elasticNodeCount

Integer

否

2

目標低峰期彈性數據節點數量。

└targetIndices

List

否

["index"]

目標彈性索引名稱，支持通配符。

└replicaCount

String

是

2

目標索引的副本數。
說明 elasticExpansionTask和elasticShrinkTask二者必須選其一，不能都為空。

示例如下。


{
    "elasticExpansionTask":
    {
        "triggerType":"crontab",
        "cronExpression":"0 0 0 ? * MON",
        "elasticNodeCount":"2",
        "targetIndices":["*"],
        "replicaCount":"2"
    }
}

返回數據

名稱 類型 示例值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****

請求ID。
Result Object

返回結果。
elasticExpansionTask Object

彈性節點擴容規則。
triggerType String crontab

觸發條件。固定為crontab，表示定時觸發。
replicaCount Integer 2

目標索引的副本數。
elasticNodeCount Integer 2

目標高峰期彈性數據節點數量。
cronExpression String 0 0 0 ? * MON

觸發周期，使用Quartz Cron表達式。
targetIndices Array of String ["index"]

目標彈性索引名稱，支持通配符。
elasticShrinkTask Object

彈性節點縮容規則。
triggerType String crontab

觸發條件?？蛇x值：crontab，表示定時觸發。
replicaCount Integer 2

目標索引的副本數。
elasticNodeCount Integer 2

目標低峰期彈性數據節點數量。
cronExpression String 4 4 4 ? * WED

觸發周期，使用Quartz Cron表達式。
targetIndices Array of String ["index"]

目標彈性索引名稱，支持通配符。

示例

請求示例

POST /openapi/instances/es-cn-6ja1ro4jt000c****/elastic-task HTTP/1.1
公共請求頭
{
    "elasticExpansionTask":
    {
        "triggerType":"crontab",
        "cronExpression":"0 0 0 ? * MON",
        "elasticNodeCount":"2",
        "targetIndices":["*"],
        "replicaCount":"2"
    }
}

正常返回示例

XML格式

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

<ModifyElastictaskResponse>
    <RequestId>ECF7F13B-A26F-44E6-B77A-5AD5AC32****</RequestId>
    <Result>
        <elasticExpansionTask>
            <TriggerType>crontab</TriggerType>
            <ReplicaCount>2</ReplicaCount>
            <CronExpression>0 0 0 ? * MON</CronExpression>
            <ElasticNodeCount>2</ElasticNodeCount>
            <TargetIndices>*</TargetIndices>
        </elasticExpansionTask>
    </Result>
</ModifyElastictaskResponse>

JSON格式

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

{
  "RequestId" : "ECF7F13B-A26F-44E6-B77A-5AD5AC32****",
  "Result" : {
    "elasticExpansionTask" : {
      "TriggerType" : "crontab",
      "ReplicaCount" : 2,
      "CronExpression" : "0 0 0 ? * MON",
      "ElasticNodeCount" : 2,
      "TargetIndices" : [ "*" ]
    }
  }
}

返回示例補充說明

以上示例表示用戶僅更新了彈性擴容規則，沒有更新彈性縮容規則。

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
404 InstanceNotFound The specified cluster does not exist. Check the cluster status and try again. 實例找不到，請核對實例狀態

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