GMOクラウド Public APIリファレンス

サポートトップ » GMOクラウド Public トップ » APIリファレンス

deployClusteringBalancer

機能の処理概要

クラスタータイプのロードバランサーの作成

クラスタータイプのロードバランサーを作成します

リクエストパラメーター

この機能の実行時には以下のパラメーターを指定してください。

パラメーター 説明 必須
label ラベル

ロードバランサーに設定するラベルを指定します
hostname ホスト名

構築するロードバランサーの hostname を指定します
hypervisor_group_id ハイパーバイザーグループID

ロードバランサーを作成する仮想サーバーを構築するハイパーバイザーに割り当てられたハイパーバイザーグループIDを指定します
ハイパーバイザーグループIDを指定しない場合は、GMOクラウドPublic の中で利用できるいずれかのハイパーバイザーにロードバランサーが構築されます
ハイパーバイザーグループIDは、3.1. listHypervisors APIで取得できます
3.1. listHypervisors API のレスポンスオブジェクトのうち、hypervisor_group_id が該当します
×
hypervisor_id ハイパーバイザーID

ロードバランサーを作成する仮想サーバーを構築するハイパーバイザーのIDを指定します
ハイパーバイザーIDを指定しない場合は、GMOクラウドPublicの全てのハイパーバイザーのうち、最もメモリ容量の残りがあるハイパーバイザーの中に構築されます
ハイパーバイザーIDは、3.1. listHypervisors APIで取得できます
3.1. listHypervisors APIのレスポンスオブジェクトのうち、id が該当します
×
nodes VM識別子リスト[ex. ABC:IP,XYZ]

構築するロードバランサーに設定する仮想サーバーを指定します

複数の仮想サーバーを指定する場合はカンマで区切ります
(例: abc123def456gh,9zyx8wvu7ts)
×
primary_network_group_id ネットワークグループID

構築する仮想サーバーに割り当てるネットワークグループのIDを指定します
ネットワークグループIDは、ネットワークグループIDは、8.1. listNetworks API で取得できます
8.1. listNetworks API のレスポンスオブジェクトのうち、network_group_id が該当します
×
rate_limit 帯域[Mbps]

構築するロードバランサーに割り当てるネットワークのポートスピードを指定します 単位は Mbps です
ports ポートリスト[ex. 80,443]

構築するロードバランサーに設定するクラスタ対象のポートを指定します

複数のポート番号を指定する場合はカンマで区切ります
(例: 80,8080,443,4443)

レスポンスオブジェクト

指定したロードバランサーの作成のリクエストに成功した場合は、以下の形式で応答します

フィールド 説明
cluster_id ロードバランサーの作成のリクエストに成功した場合、ロードバランサーに割り当てられるcluster_idを返します

指定したロードバランサーの作成のリクエストに失敗した場合は、内容に応じたエラーメッセージを返します。

リクエストサンプル

https://api.gmocloud.com/Cloud-Zone-Id/?Action=deployClusteringBalancer&AccessKeyId=AccessKeyId&Version=1.0&label=Cluster-Label-example&hostname=gmocloud.example.com&hypervisor_group_id=ID_of_HV-Group&hypervisor_id=ID_of_HV&primary_network_group_id=ID_of_NetworkGroup&rate_limit=1&ports=80%2C443&nodes=abc123def456gh%2C9zyx8wvu7ts&Signature=Signature

レスポンスサンプル

{
  "cluster_id": ID_of_Cluster
}

このガイドで問題は解決しましたか?

ご回答ありがとうございました。

引き続きGMOクラウド サポートサイトをご利用ください。

ご回答ありがとうございました。

GMOクラウド Public サポートまでお問い合わせください。

お問い合わせ