调用RestartInstance，重启指定的阿里云Elasticsearch实例。
重启后，实例进入生效中（activing）状态。重启成功后，实例状态变为正常（active）。阿里云Elasticsearch支持单节点重启，节点重启分为普通重启和蓝绿重启。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试请求头
该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。
请求语法
POST /openapi/instances/{InstanceId}/actions/restart HTTP/1.1请求参数
| 名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
|---|
| 名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|---|
| InstanceId | String | Path | 是 | es-cn-nif1q8auz0003**** | 实例ID。 |
| force | Boolean | Query | 否 | false | 是否忽略集群状态，强制重启。
|
| clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | 用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。 |
| String | Body | 否 | { "restartType":"nodeIp", "nodes":["172.16.xx.xx","172.16.xx.xx"], "blueGreenDep":true } | 指定重启参数信息。 |
RequestBody
RequestBody中还需填入以下参数，用来指定重启参数信息。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
|
|---|---|---|---|---|---|
restartType |
String |
否 |
instance |
重启类型。可选值： instance（默认）：实例重启。 nodeIp：节点重启，需要指定节点的IP地址。 nodeEcsId：节点重启，需要指定集群中ECS实例的ID。 |
|
nodes |
List<String> |
否 |
["127.0.*.*"] |
选择节点重启时，指定待重启的节点的IP地址或ID。 |
|
blueGreenDep |
Boolean |
否 |
false |
节点重启时，是否启用蓝绿部署，默认值为false。 |
|
batchCount |
Double |
否 |
25.0 |
实例强制重启时，设置的并发度。 |
|
batchUnit |
String |
否 |
percent |
batchCount的单位，默认为percent。 |
- restartType不传或者传空字符串时，默认为instance。为instance时，默认忽略blueGreenDep参数，并且需要满足以下条件：
- force为true时，batchCount必须大于0，小于等于100，否则会报错RestartBatchValueError。
- force为false时，batchCount默认为0，设置为其他值时，会报错NormalRestartNotSupportBatch。
- restartType为nodeIp时，默认忽略batchCount参数，并且需要满足以下条件：
- nodes不可为空，否则提醒参数错误。
- blueGreenDep为true时，在重启节点时，会启用蓝绿部署。为false时，不会启用蓝绿部署，即正常重启。
示例如下。
{
"restartType":"nodeIp",
"nodes": ["172.16.xx.xx"],
"blueGreenDep":true
}
返回数据
以下返回示例中，本文只保证包含返回数据列表中的参数，而未提到的参数仅供参考，程序中不能强制依赖获取这些参数。
示例
请求示例
POST /openapi/instances/es-cn-nif1q8auz0003****/actions/restart HTTP/1.1
公共请求头
{
"restartType":"nodeIp",
"nodes":["172.16.xx.xx","172.16.xx.xx"],
"blueGreenDep":true
}正常返回示例
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : {
"instanceId" : "es-cn-nif1q8auz0003****",
"version" : "7.4.0_with_X-Pack",
"description" : "es-cn-nif1q8auz0003****",
"nodeAmount" : 3,
"paymentType" : "prepaid",
"status" : "active",
"privateNetworkIpWhiteList" : [ "0.0.0.0/0" ],
"enablePublic" : false,
"nodeSpec" : {
"spec" : "elasticsearch.n4.small",
"disk" : 20,
"diskType" : "cloud_ssd",
"diskEncryption" : false
},
"networkConfig" : {
"vpcId" : "vpc-bp16k1dvzxtmagcva****",
"vswitchId" : "vsw-bp1k4ec6s7sjdbudw****",
"vsArea" : "cn-hangzhou-i",
"type" : "vpc"
},
"createdAt" : "2020-07-06T10:18:48.662Z",
"updatedAt" : "2020-07-06T10:18:48.662Z",
"commodityCode" : "elasticsearchpre",
"extendConfigs" : [ {
"configType" : "usageScenario",
"value" : "general"
}, {
"configType" : "maintainTime",
"maintainStartTime" : "02:00Z",
"maintainEndTime" : "06:00Z"
} ],
"endTime" : 1596729600000,
"clusterTasks" : [ ],
"vpcInstanceId" : "es-cn-nif1q8auz0003****-worker",
"resourceGroupId" : "rg-acfm2h5vbzd****",
"zoneCount" : 1,
"protocol" : "HTTP",
"zoneInfos" : [ {
"zoneId" : "cn-hangzhou-i",
"status" : "NORMAL"
} ],
"instanceType" : "elasticsearch",
"inited" : true,
"tags" : [ ],
"domain" : "es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com",
"port" : 9200,
"esVersion" : "7.4.0_with_X-Pack",
"esConfig" : {
"action.destructive_requires_name" : "true",
"xpack.watcher.enabled" : "false",
"action.auto_create_index" : "+.*,-*"
},
"esIPWhitelist" : [ "0.0.0.0/0" ],
"esIPBlacklist" : [ ],
"kibanaIPWhitelist" : [ "0.0.0.0/0", "::/0" ],
"kibanaPrivateIPWhitelist" : [ ],
"publicIpWhitelist" : [ ],
"kibanaDomain" : "es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com",
"kibanaPort" : 5601,
"haveKibana" : true,
"instanceCategory" : "x-pack",
"dedicateMaster" : false,
"advancedDedicateMaster" : false,
"masterConfiguration" : { },
"haveClientNode" : false,
"warmNode" : false,
"warmNodeConfiguration" : { },
"clientNodeConfiguration" : { },
"kibanaConfiguration" : {
"spec" : "elasticsearch.n4.small",
"amount" : 1,
"disk" : 0
},
"dictList" : [ {
"name" : "SYSTEM_MAIN.dic",
"fileSize" : 2782602,
"sourceType" : "ORIGIN",
"type" : "MAIN"
}, {
"name" : "SYSTEM_STOPWORD.dic",
"fileSize" : 132,
"sourceType" : "ORIGIN",
"type" : "STOP"
} ],
"synonymsDicts" : [ ],
"ikHotDicts" : [ ],
"aliwsDicts" : [ ],
"haveGrafana" : false,
"haveCerebro" : false,
"enableKibanaPublicNetwork" : true,
"enableKibanaPrivateNetwork" : false,
"advancedSetting" : {
"gcName" : "CMS"
}
},
"RequestId" : "BB58A51D-CE72-49F9-AF08-F57F3C8A****"
}错误码
访问错误中心查看更多错误码。