ロードバランシング用のサーバーグループを作成します。
操作説明
CreateServerGroup API は非同期処理です。API を呼び出すと、システムはリクエスト ID を返し、バックグラウンドでサーバーグループの作成を開始します。作成状況を確認するには、ListServerGroups API を呼び出してサーバーグループのステータスを照会してください:
Creating ステータス:サーバーグループが作成中であることを示します。
Available ステータス:サーバーグループの作成が完了したことを示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
gwlb:CreateServerGroup |
create |
*ServerGroup
*VPC
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ServerGroupType |
string |
任意 |
サーバーグループのタイプ。有効な値は以下のとおりです:
|
Instance |
| ServerGroupName |
string |
任意 |
サーバーグループの名前。 名前の長さは 2~128 文字で、英字または漢字で始める必要があります。また、数字、ピリオド(.)、アンダースコア(_)、ハイフン(-)を含めることができます。 |
testServerGroupName |
| Protocol |
string |
任意 |
バックエンドサーバーで使用するプロトコル。有効な値は以下のとおりです:
列挙値:
|
GENEVE |
| Scheduler |
string |
任意 |
スケジューリングアルゴリズム。有効な値は以下のとおりです:
|
5TCH |
| ServerFailoverMode |
string |
任意 |
バックエンドサーバーが不健全になった場合の既存接続の処理方法。有効な値は以下のとおりです:
|
NoRebalance |
| VpcId |
string |
必須 |
仮想プライベートクラウド(VPC)の ID。 説明
ServerGroupType を Instance に設定した場合、この VPC 内のサーバーのみをサーバーグループに追加できます。 |
vpc-bp15zckdt37pq72zv**** |
| ResourceGroupId |
string |
任意 |
リソースグループの ID。 |
rg-atstuj3rtop**** |
| ConnectionDrainConfig |
object |
任意 |
接続ドレインの構成。 |
|
| ConnectionDrainEnabled |
boolean |
任意 |
接続ドレインを有効にするかどうかを指定します。有効な値は以下のとおりです:
|
false |
| ConnectionDrainTimeout |
integer |
任意 |
接続ドレインのタイムアウト値。 単位:秒。 有効な値: 1 ~ 3600。 デフォルト値: 300。 |
300 |
| HealthCheckConfig |
object |
任意 |
ヘルスチェック設定。 |
|
| HealthCheckConnectPort |
integer |
任意 |
ヘルスチェックに使用するバックエンドサーバーのポート。 有効な値: 1 ~ 65535。 デフォルト値: 80。 |
80 |
| HealthCheckConnectTimeout |
integer |
任意 |
ヘルスチェック応答の最大タイムアウト値。 単位:秒。 有効な値: 1 ~ 300。 デフォルト値: 5。 |
5 |
| HealthCheckDomain |
string |
任意 |
ヘルスチェックに使用するドメイン名。有効な値は以下のとおりです:
説明
このパラメーターは、HealthCheckProtocol を HTTP に設定した場合にのみ有効です。 |
$SERVER_IP |
| HealthCheckEnabled |
boolean |
任意 |
ヘルスチェックを有効にするかどうかを指定します。有効な値は以下のとおりです:
|
true |
| HealthCheckHttpCode |
array |
任意 |
正常なバックエンドサーバーを示す HTTP ステータスコード。 |
|
|
string |
任意 |
ヘルスチェックが成功したことを示す HTTP ステータスコード。カンマ区切りで複数の値を指定できます。有効な値は以下のとおりです:
デフォルト値: http_2xx。 説明
このパラメーターは、HealthCheckProtocol を HTTP に設定した場合にのみ有効です。 |
http_2xx |
|
| HealthCheckInterval |
integer |
任意 |
ヘルスチェックの間隔。 単位:秒。 有効な値: 1 ~ 50。 デフォルト値: 10。 |
10 |
| HealthCheckPath |
string |
任意 |
ヘルスチェックに使用するパス。 パスの長さは 1~80 文字で、先頭はスラッシュ(/)で始める必要があります。また、英字、数字、および以下の特殊文字を含めることができます: 先頭はスラッシュ(/)で始める必要があります。 説明
このパラメーターは、HealthCheckProtocol を HTTP に設定した場合にのみ有効です。 |
/test/index.html |
| HealthCheckProtocol |
string |
任意 |
ヘルスチェックに使用するプロトコル。有効な値は以下のとおりです:
|
TCP |
| HealthyThreshold |
integer |
任意 |
バックエンドサーバーを「健全」と見なすために必要な、連続した成功ヘルスチェックの回数(「不健全」から「健全」へと状態が変化した後)。 有効な値: 2 ~ 10。 デフォルト値: 2。 |
2 |
| UnhealthyThreshold |
integer |
任意 |
バックエンドサーバーを「不健全」と見なすために必要な、連続した失敗ヘルスチェックの回数(「健全」から「不健全」へと状態が変化した後)。 有効な値: 2 ~ 10。 デフォルト値: 2。 |
2 |
| HealthCheckReq |
string |
任意 |
||
| HealthCheckExp |
string |
任意 |
||
| Tag |
array<object> |
任意 |
タグ。 1 回のリクエストで最大 20 個のタグを指定できます。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
タグキー。空文字列にすることはできません。長さは最大 128 文字で、 |
testTagKey |
| Value |
string |
任意 |
タグ値。長さは最大 256 文字で、 |
testTagValue |
| DryRun |
boolean |
任意 |
ドライランを実行するかどうかを指定します。有効な値は以下のとおりです:
|
False |
| ClientToken |
string |
任意 |
クライアントが生成する、グローバルに一意なトークンで、リクエストのべき等性を保証するために使用されます。 クライアント側でトークンを生成できますが、異なるリクエスト間でトークンが一意であることを保証する必要があります。クライアントトークンには ASCII 文字のみを使用できます。 説明
このパラメーターを指定しない場合、システムは自動的に API リクエストの RequestId を ClientToken として使用します。RequestId は各 API リクエストに対して一意です。 |
123e4567-e89b-12d3-a456-42665544**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
54B48E3D-DF70-471B-AA93-08E683A1B45 |
| ServerGroupId |
string |
サーバーグループ ID。 |
sgp-atstuj3rtoptyui**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
"ServerGroupId": "sgp-atstuj3rtoptyui****"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalParam.HealthCheckProtocol | The param of %s is illegal. | |
| 400 | QuotaExceeded.ServerGroupsNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | DuplicatedParam.TagKey | The param of %s is duplicated. | |
| 400 | IllegalParam.TagKey | The param of %s is illegal. | |
| 404 | ResourceNotFound.Vpc | The specified resource of %s is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。