指定した Elasticsearch クラスターを再起動します。
デバッグ
リクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。 詳細については、「共通リクエストヘッダー」をご参照ください。
リクエスト構文
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**** | リクエストのべき等性を確保するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。 |
String | Body | いいえ | { "restartType":"nodeIp", "nodes":["172.16.xx.xx","172.16.xx.xx"], "blueGreenDep":true } | 再起動パラメーター情報を指定します。 |
リクエストボディ
再起動パラメーターを指定するには、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 | クラスターのステータス。次の構成がサポートされています。
|
kibanaPort | Integer | 5601 | インターネット経由でクラスターの Kibana コンソールにアクセスするために使用されるポート番号。 |
publicPort | Integer | 9200 | インターネット経由でクラスターにアクセスするために使用されるポート番号。 |
paymentType | String | 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 | 辞書のタイプ。有効な値:
|
name | String | SYSTEM_MAIN.dic | 辞書ファイルの名前。 |
sourceType | String | ORIGIN | 辞書ファイルのソースのタイプ。有効な値:
|
synonymsDicts | Array of synonymsDicts | 類義語辞書の構成。 |
|
fileSize | Long | 2782602 | 辞書ファイルのサイズ。単位: バイト。 |
type | String | STOP | 辞書のタイプ。有効な値:
|
name | String | SYSTEM_MAIN.dic | 辞書ファイルの名前。 |
sourceType | String | ORIGIN | 辞書ファイルのソースのタイプ。有効な値:
|
kibanaConfiguration | Object | Kibana ノードの構成。 |
|
spec | String | elasticsearch.n4.small | ノードの仕様。 |
amount | Integer | 1 | ノードの数。 |
disk | Integer | 20 | ノードストレージスペースのサイズ。単位: GB。 |
diskType | String | cloud_ssd | ストレージタイプ。 |
masterConfiguration | Object | 専用マスターノードの構成。 |
|
spec | String | elasticsearch.sn2ne.large | ノードの仕様。 |
amount | Integer | 3 | ノードの数。 |
disk | Integer | 20 | ノードストレージスペースのサイズ。単位: GB。 |
diskType | String | cloud_ssd | ストレージタイプ。 cloud_ssd のみサポートされています。 |
networkConfig | Object | ネットワーク構成。 |
|
vpcId | String | vpc-bp16k1dvzxtmagcva**** | クラスターの VPC ID。 |
vsArea | String | cn-hangzhou-i | NLB インスタンスのゾーンを選択します。 |
type | String | vpc | ネットワークタイプ。 VPC のみサポートされています。 |
vswitchId | String | vsw-bp1k4ec6s7sjdbudw**** | クラスターの vSwitch 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****"
}
HTTP ステータスコード
エラーコードのリストについては、「サービスエラーコード」をご参照ください。