ModifyElastictask_Elasticsearch_API调试-阿里云OpenAPI开发者门户

请求语法

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

路径参数

字段名称	字段详情
InstanceIdstring	实例 ID。示例值:es-cn-6ja1ro4jt000c****参考取值来源: ListInstance

请求参数

字段名称	字段详情
bodystring	指定扩缩容信息。示例值:{ "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"
    }
}

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****
Resultobject	返回结果。

变更历史

暂无变更历史