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

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

deployAutoScalingBalancer

機能の処理概要

オートスケールタイプのロードバランサーの作成

オートスケールタイプのロードバランサーを作成します

リクエストパラメーター

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

パラメーター 説明 必須
autoscaling_in_cpu ノード削除 CPU条件[継続時間,削除ノード数,CPU負荷[%]]

CPU負荷に応じてオートスケールインさせる際の条件を指定します
条件のパラメーターはカンマで区切ります
×
autoscaling_in_memory ノード削除メモリ条件[継続時間,削除ノード数,残メモリ[MB]]

残メモリに応じてオートスケールインさせる際の条件を指定します
条件のパラメーターはカンマで区切ります
×
autoscaling_out_cpu ノード追加 CPU条件[継続時間,追加ノード数,CPU負荷[%]]

CPU負荷に応じてオートスケールアウトさせる際の条件を指定します
条件のパラメーターはカンマで区切ります
×
autoscaling_out_memory ノード追加メモリ条件[継続時間,追加ノード数,残メモリ[MB]]

残メモリに応じてオートスケールアウトさせる際の条件を指定します
条件のパラメーターはカンマで区切ります
×
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 が該当します
×
max_node_amount 最大ノード数

オートスケールアウトで構築する仮想サーバーの最大ノード数を指定します
min_node_amount 最小ノード数

オートスケールインでノードを削除する際に残す最小限の仮想サーバー数を指定します
node_cpu_shares ノード CPU占有率

オートスケールアウトで構築する仮想サーバーに割り当てるCPU占有率を指定します
このパラメーターを指定しない場合の初期値は 1 です

単位は % (Percent)です
×
node_cpus ノード CPUコア数

オートスケールアウトで構築する仮想サーバーに割り当てる仮想CPUコア数を指定します

単位は 個 です
node_memory ノード メモリ[MB]

オートスケールアウトで構築する仮想サーバーに割り当てるメモリ容量を指定します

単位は MB(MegaByte)です
node_rate_limit ノード 帯域[Mbps]

オートスケールアウトで構築する仮想サーバーに割り当てるネットワークのポートスピードを指定します

単位は Mbps です
node_template_id テンプレートID

オートスケールアウトで構築する仮想サーバーが使用するテンプレートのIDを指定します

システムテンプレートとユーザーテンプレートのIDは、11.1. listImages APIで取得できます
11.1. listImagesのレスポンスオブジェクトのうち、id が該当します
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=deployAutoScalingBalancer&AccessKeyId=AccessKeyId&Version=1.0&label=LB-Label-example&hostname=gmocloud.example.com&rate_limit=1&ports=80%2C443&node_cpus=1&node_memory= 128&node_rate_limit=1&node_template_id=ID_of_Template&max_node_amount=2&min_node_amount=1&auto_scaling_in_cpu= 20%2C1%2C90&auto_scaling_in_memory=20%2C1%2C42&auto_scaling_out_cpu=5%2C1%2C1&auto_scaling_out_memory= 5%2C1%2C1&hypervisor_group_id=ID_of_HV-Group&hypervisor_id=ID_of_HV&node_cpu_shares=1&primary_network_group_id=ID_of_NetworkGroup&Signature=Signature

レスポンスサンプル

{
  "cluster_id": ID_of_Cluster
}

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

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

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

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

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

お問い合わせ