インスタンスのHA機能のオン/オフを設定したい
サーバーインスタンス, 運用
2017年4月19日 (2025年1月17日:更新）
HA機能のオン/オフ設定方法につきまして、下記のいずれかをお客さま自身で実施いただくことで、設定が可能となります。
デフォルトでは、HA機能はオンとなります。オフにした場合の注意点やデメリットは下記のリンク先をご確認ください。
・仮想サーバのHA設定をオフにした場合、どのようなデメリットがありますか？
※早期の復旧をご希望の場合や、起動ができない場合には、チケットにてお問い合わせください。
インスタンスの復旧対応後、インスタンスのステータスは電源ONの状態でお渡しする場合がございます。
復旧対応につきましては平日日勤帯での対応になりますことご了承ください。
■ポータルで設定する方法
１．設定対象のインスタンスの操作にて、「インスタンスの編集」を選択。
２．メタデータの「HA利用」のチェック有無にて、HA機能の設定オン/オフを選択。
３．チェック有りの場合 HA機能オン、 チェック無しの場合 HA機能オフ。
４．「インスタンスの編集」を選択することで、HA機能の設定オン/オフの設定を反映。
■APIで設定する方法
１．設定対象のインスタンスに対して、metadata設定値”HA_Enabled”を”true”か”false”を指定してAPI実行することで設定することができます。
【使用するAPI】
Create or replace server metadata items
【API実行例】
▼ JP1〜JP6
🔲 HA_Enabledをfalseと指定した場合
| $ curl -ik -X PUT ${api_endpoint}/v2/${tenant_id}/servers/${server_id}/metadata -H “Accept: application/json” -H “Content-Type: application/json” -H “X-Auth-Token: ${TOKEN}” -d ‘{“metadata”: {“HA_Enabled”: “false”}}’ HTTP/1.1 200 OK Date: Thu, 09 Jan 2025 08:57:40 GMT Server: Apache Content-Length: 54 X-Compute-Request-Id: req-8c386574-f097-4bbb-9cd3-f0a8eba688c0 Content-Type: application/json Connection: close{“metadata”: {“vmha”: “false”, “HA_Enabled”: “false”}} |
🔲 HA_Enabledをtrueと指定した場合
| $ curl -ik -X PUT ${api_endpoint}/v2/${tenant_id}/servers/${server_id}/metadata -H “Accept: application/json” -H “Content-Type: application/json” -H “X-Auth-Token: ${TOKEN}” -d ‘{“metadata”: {“HA_Enabled”: “true”}}’ HTTP/1.1 200 OK Date: Thu, 09 Jan 2025 08:57:52 GMT Server: Apache Content-Length: 52 X-Compute-Request-Id: req-e5875ff8-c8af-4168-9a28-02c45196278b Content-Type: application/json Connection: close{“metadata”: {“vmha”: “true”, “HA_Enabled”: “true”}} |
🔲 HA_Enabledを指定しない場合
| $ curl -ik -X PUT ${api_endpoint}/v2/${tenant_id}/servers/${server_id}/metadata -H “Accept: application/json” -H “Content-Type: application/json” -H “X-Auth-Token: ${TOKEN}” -d ‘{“metadata”: {}}’ HTTP/1.1 200 OK Date: Thu, 09 Jan 2025 08:58:05 GMT Server: Apache Content-Length: 16 X-Compute-Request-Id: req-a94bf317-1357-4c44-9d54-be95d4db21f8 Content-Type: application/json Connection: close{“metadata”: {}} |
▼ JP7〜
🔲 HA_Enabledをfalseと指定した場合
| $ curl -ik -X PUT ${api_endpoint}/v2/${tenant_id}/servers/${server_id}/metadata -H “Accept: application/json” -H “Content-Type: application/json” -H “X-Auth-Token: ${TOKEN}” -d ‘{“metadata”: {“HA_Enabled”: “false”}}’ HTTP/1.1 200 OK content-length: 37 content-type: application/json x-openstack-request-id: req-7495b8a3-28e9-422e-b5ec-a9debdf5cbce x-compute-request-id: req-7495b8a3-28e9-422e-b5ec-a9debdf5cbce date: Thu, 09 Jan 2025 09:08:06 GMT x-envoy-upstream-service-time: 472 server: envoy{“metadata”: {“HA_Enabled”: “false”}} |
🔲 HA_Enabledをtrueと指定した場合
| $ curl -ik -X PUT ${api_endpoint}/v2/${tenant_id}/servers/${server_id}/metadata -H “Accept: application/json” -H “Content-Type: application/json” -H “X-Auth-Token: ${TOKEN}” -d ‘{“metadata”: {“HA_Enabled”: “true”}}’ HTTP/1.1 200 OK content-length: 36 content-type: application/json x-openstack-request-id: req-10866c30-9202-47c1-819c-c3d51208962c x-compute-request-id: req-10866c30-9202-47c1-819c-c3d51208962c date: Thu, 09 Jan 2025 09:08:21 GMT x-envoy-upstream-service-time: 369 server: envoy{“metadata”: {“HA_Enabled”: “true”}} |
🔲 HA_Enabledを指定しない場合
| $ curl -ik -X PUT ${api_endpoint}/v2/${tenant_id}/servers/${server_id}/metadata -H “Accept: application/json” -H “Content-Type: application/json” -H “X-Auth-Token: ${TOKEN}” -d ‘{“metadata”: {}}’ HTTP/1.1 200 OK content-length: 16 content-type: application/json x-openstack-request-id: req-3e86e288-aa4d-4512-824d-2363be76f82c x-compute-request-id: req-3e86e288-aa4d-4512-824d-2363be76f82c date: Thu, 09 Jan 2025 09:08:41 GMT x-envoy-upstream-service-time: 225 server: envoy{“metadata”: {}} |
※{“metadata”: {}}で実行した場合、HA機能はオンとなります。
※HA機能をオフにするには、{“metadata”: {“HA_Enabled”: “false”}}としてください。
２．設定対象のインスタンスに対して、対象のAPI実行することでHA機能の設定状態を確認することができます。
【使用するAPI】
Show server metadata
【API実行例】
▼ JP1〜JP6
| $ curl -ik -X GET ${api_endpoint}/v2/${tenant_id}/servers/${server_id}/metadata -H “Accept: application/json” -H “Content-Type: application/json” -H “X-Auth-Token: ${TOKEN}” HTTP/1.1 200 OK Date: Thu, 09 Jan 2025 08:29:19 GMT Server: Apache Content-Length: 52 Content-Type: application/json X-Compute-Request-Id: req-d4016acd-8ff6-46fc-a2de-0b28adcf782d Connection: close{“metadata”: {“vmha”: “true”, “HA_Enabled”: “true”}} |
▼ JP7〜
| $ curl -ik -X GET ${api_endpoint}/v2/${tenant_id}/servers/${server_id}/metadata -H “Accept: application/json” -H “Content-Type: application/json” -H “X-Auth-Token: ${TOKEN}” HTTP/1.1 200 OK content-length: 36 content-type: application/json x-openstack-request-id: req-cbaa7a8d-7e78-4d10-b10d-2e119739f328 x-compute-request-id: req-cbaa7a8d-7e78-4d10-b10d-2e119739f328 date: Thu, 09 Jan 2025 09:08:32 GMT x-envoy-upstream-service-time: 69 server: envoy{“metadata”: {“HA_Enabled”: “true”}} |