Gateway Load Balancer (GWLB) インスタンスのサーバーグループを作成します。
操作説明
CreateServerGroup は非同期操作です。リクエストの送信後、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。ListServerGroups 操作を呼び出して、タスクのステータスをクエリできます。
サーバーグループが作成中ステータスの場合、サーバーグループが作成中であることを示します。
サーバーグループが利用可能ステータスの場合、サーバーグループが作成されたことを示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
gwlb:CreateServerGroup |
create |
*ServerGroup
*VPC
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ServerGroupType |
string |
任意 |
サーバーグループのタイプ。有効な値:
|
Instance |
| ServerGroupName |
string |
任意 |
サーバーグループ名。 名前は 2~128 文字で、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は英字である必要があります。 |
testServerGroupName |
| Protocol |
string |
任意 |
バックエンドプロトコル。有効な値:
列挙値:
|
GENEVE |
| Scheduler |
string |
任意 |
スケジューリングアルゴリズム。有効な値:
|
5TCH |
| ServerFailoverMode |
string |
任意 |
バックエンドサーバーが正常に動作していない場合に、GWLB が既存の接続を介してリクエストを処理する方法を指定します。有効な値:
|
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 ステータスコードはコンマ (,) で区切ります。有効な値:
デフォルト値:http_2xx。 説明
このパラメーターは、HealthCheckProtocol を HTTP に設定した場合にのみ有効になります。 |
http_2xx |
|
| HealthCheckInterval |
integer |
任意 |
ヘルスチェックが実行される間隔。 単位:秒。 有効な値:1~50。 デフォルト値:10。 |
10 |
| HealthCheckPath |
string |
任意 |
ヘルスチェックに使用されるパス。 長さは 1~80 文字で、英字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、パーセント記号 (%)、疑問符 (?)、番号記号 (#)、アンパサンド (&) を使用できます。URL には、次の拡張文字も使用できます:_ ; ~ ! ( ) * [ ] @ $ ^ : ' , + = 先頭はスラッシュ (/) である必要があります。 説明
このパラメーターは、HealthCheckProtocol を HTTP に設定した場合にのみ有効になります。 |
/test/index.html |
| HealthCheckProtocol |
string |
任意 |
ヘルスチェックに使用されるプロトコル。有効な値:
|
TCP |
| HealthyThreshold |
integer |
任意 |
異常なバックエンドサーバーが正常と判断されるまでに連続してヘルスチェックに合格する必要がある回数。この場合、バックエンドサーバーのヘルスチェックステータスは fail から success に変わります。 有効な値:2~10。 デフォルト値:2。 |
2 |
| UnhealthyThreshold |
integer |
任意 |
正常なバックエンドサーバーが異常と判断されるまでに連続してヘルスチェックに失敗する必要がある回数。この場合、バックエンドサーバーのヘルスチェックステータスは success から fail に変わります。 有効な値:2~10。 デフォルト値:2。 |
2 |
| Tag |
array<object> |
任意 |
タグキー。 各呼び出しで最大 20 個のタグを指定できます。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
タグキー。タグキーは空の文字列にできません。タグキーは最大 128 文字で、 |
testTagKey |
| Value |
string |
任意 |
タグ値。タグ値は最大 256 文字で、 |
testTagValue |
| DryRun |
boolean |
任意 |
実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値:
|
False |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。 説明
このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。 |
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。