调用GetElastictask,获取集群的弹性扩缩容规则。必须在创建实例时购买弹性节点,才可调用此接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /openapi/instances/[InstanceId]/elastic-task HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
InstanceId | String | Path | 是 | es-cn-6ja1ro4jt000c**** |
实例ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D*** |
请求ID。 |
Result | Struct |
返回结果。 |
|
elasticExpansionTask | Struct |
弹性扩容规则。 |
|
cronExpression | String | 0 0 0 ? * MON |
触发周期,使用Quartz Cron表达式。 |
elasticNodeCount | Integer | 2 |
目标高峰期弹性数据节点数量。 |
replicaCount | Integer | 2 |
目标索引的副本数。 |
targetIndices | List | index |
目标弹性索引名称,支持通配符。 |
triggerType | String | crontab |
触发条件。目前仅支持crontab,表示定时触发。 |
elasticShrinkTask | Struct |
弹性缩容规则。 |
|
cronExpression | String | 4 4 4 ? * WED |
触发周期,使用Quartz Cron表达式。 |
elasticNodeCount | Integer | 2 |
目标低峰期弹性数据节点数量。 |
replicaCount | Integer | 2 |
目标索引的副本数。 |
targetIndices | List | index |
目标弹性索引名称,支持通配符。 |
triggerType | String | crontab |
触发条件。目前仅支持crontab,表示定时触发。 |
示例
请求示例
GET /openapi/instances/es-cn-6ja1ro4jt000c****/elastic-task HTTP/1.1
公共请求头
正常返回示例
JSON
格式
{
"RequestId": "ECF7F13B-A26F-44E6-B77A-5AD5AC32****",
"Result": {
"ElasticShrinkTask": {
"TriggerType": "crontab",
"ReplicaCount": 0,
"CronExpression": "4 4 4 ? * WED",
"ElasticNodeCount": 2,
"TargetIndices": [
"my_index"
]
},
"ElasticExpansionTask": {
"TriggerType": "crontab",
"ReplicaCount": 1,
"CronExpression": "0 0 0 ? * MON",
"ElasticNodeCount": 3,
"TargetIndices": [
"my_index"
]
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InstanceNotFound | The specified cluster does not exist. Check the cluster status and try again. | 实例找不到,请核对实例状态。 |
访问错误中心查看更多错误码。