調用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

是否忽略集群狀態，強制重啟。

  • true：忽略
  • 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
}

返回數據

名稱 類型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DC****

請求ID。
Result Object

返回結果。
nodeAmount Integer 2

實例的數據節點數量。
publicDomain String es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com

公網訪問地址。
createdAt String 2020-07-06T10:18:48.662Z

實例創建時間。
status String active

實例的狀態。支持：

  • active：正常
  • activating：生效中
  • inactive：凍結
  • invalid：失效
kibanaPort Integer 5601

Kibana公網端口。
publicPort Integer 9200

公網端口。
paymentType String postpaid

實例的付費方式。

支持：prepaid（包年包月）和postpaid（按量付費）。
domain String es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com

實例的內網訪問地址。
description String es-cn-abc

實例名稱。
esVersion String 6.7.0_with_X-Pack

實例版本。
kibanaDomain String es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com

Kibana公網訪問地址。
updatedAt String 2018-07-18T10:10:04.484Z

實例最后更新的時間。
instanceId String es-cn-n6w1o1x0w001c****

實例ID。
dictList Array of dictList

IK詞典配置。
fileSize Long 2782602

詞典文件大小，單位：字節。
type String MAIN

詞典類型，取值：

  • STOP：停用詞
  • MAIN：主詞典
  • SYNONYMS：同義詞詞典
  • ALI_WS：阿里詞典
name String SYSTEM_MAIN.dic

詞典文件名稱。
sourceType String ORIGIN

來源類型，支持：

  • OSS：OSS開放存儲（需要確保OSS存儲空間為公共可讀）
  • ORIGIN：開源Elasticsearch
  • UPLOAD：上傳的文件
synonymsDicts Array of synonymsDicts

同義詞詞典配置。
fileSize Long 2782602

詞典文件大小，單位：字節。
type String STOP

詞典類型，取值：

  • STOP：停用詞
  • MAIN：主詞典
  • SYNONYMS：同義詞詞典
  • ALI_WS：阿里詞典
name String SYSTEM_MAIN.dic

詞典文件名稱。
sourceType String ORIGIN

來源類型，支持：

  • OSS：OSS開放存儲（需要確保OSS存儲空間為公共可讀）
  • ORIGIN：開源Elasticsearch
  • UPLOAD：上傳的文件
kibanaConfiguration Object

Kibana節點配置。
spec String elasticsearch.n4.small

節點規格。
amount Integer 1

節點數量。
disk Integer 20

節點存儲空間大小，單位為GB。
diskType String cloud_ssd

節點存儲類型。
masterConfiguration Object

Master節點配置。
spec String elasticsearch.sn2ne.large

節點規格。
amount Integer 3

節點數量。
disk Integer 20

節點存儲空間大小，單位為GB。
diskType String cloud_ssd

節點存儲類型。只支持cloud_ssd（SSD云盤）。
networkConfig Object

網絡配置。
vpcId String vpc-bp16k1dvzxtmagcva****

專有網絡ID。
vsArea String cn-hangzhou-i

實例所在的可用區。
type String vpc

網絡類型，只支持專有網絡VPC（Virtual Private Cloud）。
vswitchId String vsw-bp1k4ec6s7sjdbudw****

虛擬交換機ID。
nodeSpec Object

數據節點配置信息。
spec String elasticsearch.n4.small

節點規格。
disk Integer 50

節點的存儲空間大小，單位為GB。
diskType String cloud_ssd

節點的存儲類型。

以下返回示例中，本文只保證包含返回數據列表中的參數，而未提到的參數僅供參考，程序中不能強制依賴獲取這些參數。

示例

請求示例

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****"
}

錯誤碼

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