調用EstimatedRestartTime,獲取重啟實例的預估時間。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數文檔。
請求語法
POST /openapi/instances/{InstanceId}/estimated-time/restart-time HTTP/1.1
請求參數
名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|---|
InstanceId | String | Path | 是 | es-cn-n6w1o1x0w001c**** | 實例ID。 |
force | Boolean | Query | 否 | false | 是否是強制重啟。默認:false。 |
String | Body | 否 | { "restartType":"nodeIp", "nodes": ["172.16.xx.xx"], "blueGreenDep":true } | 指定重啟參數信息。 |
RequestBody
RequestBody中還可以填入以下參數,用來指定重啟參數信息。
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
---|---|---|---|---|
restartType |
String |
否 |
instance |
重啟類型,支持: instance(默認):重啟實例。 nodeIp:節點重啟。 |
nodes |
List<String> |
否 |
["127.0.0.1"] |
選擇節點重啟時,目標節點的IP地址列表。 |
blueGreenDep |
Boolean |
否 |
false |
節點重啟時,是否進行藍綠變更。默認值:false。 |
batch |
double |
否 |
25.0 |
實例強制重啟的并發度。默認值:1/實例總節點數。 |
batchUnit |
String |
否 |
percent |
batch單位。默認值:percent。 |
說明
- restartType為instance時,忽略blueGreenDep參數。
- force為true,batch必須大于0,小于等于100,否則系統會提示RestartBatchValueError的報錯。
- force為false,batch默認為0,輸入其他值時,會報錯NormalRestartNotSupportBatch。
- restartType為nodeIp時,忽略batch參數。
- nodeIp為空,系統會提示參數錯誤。
- blueGreenDep為true,進行藍綠變更重啟;為false,正常重啟。
示例如下。
{
"restartType":"nodeIp",
"nodes": ["172.16.xx.xx"],
"blueGreenDep":true
}
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | 請求ID。 |
Result | Object | 返回結果。 |
|
unit | String | second | 單位。 |
value | Long | 50 | 重啟預估時間。 |
示例
請求示例
POST /openapi/instances/es-cn-n6w1o1x0w001c****/estimated-time/restart-time?force=true HTTP/1.1
公共請求頭
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : {
"unit" : "second",
"value" : 4200
},
"RequestId" : "7ACE8751-DD1B-40DB-A253-9080CA58****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。