すべてのプロダクト
Search

このプロダクト

    Server Load Balancer:CreateServerGroup

    ドキュメントセンター

    Server Load Balancer:CreateServerGroup

    最終更新日:May 30, 2026

    指定されたリージョンにサーバーグループを作成します。

    操作説明

    CreateServerGroup API は非同期です。リクエストを送信すると、システムからリクエスト ID が返されますが、サーバーグループはバックグラウンドで作成中です。ListServerGroups API を呼び出して、サーバーグループのステータスを照会できます。

    • サーバーグループの状態が Creating の場合、作成中です。

    • サーバーグループの状態が Available の場合、作成済みです。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    alb:CreateServerGroup

    create

    *ServerGroup

    acs:alb:{#regionId}:{#accountId}:servergroup/*
    • alb:ServerGroupProtocol
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ServerGroupName

    string

    必須

    サーバーグループの名前です。長さは 2～128 文字で、先頭は英字、数字、または中国語文字である必要があります。数字、ピリオド (.)、アンダースコア (_)、ハイフン (-)、スペースも使用できます。

    test
    ServerGroupType

    string

    任意

    サーバーグループのタイプです。有効な値：

    • Instance (デフォルト)：インスタンスタイプのサーバーグループです。このタイプのサーバーグループには、ECS インスタンス、Elastic Network Interface (ENI)、および Elastic Container Instance (ECI) を追加できます。

    • Ip：IP タイプのサーバーグループです。このタイプのサーバーグループには、バックエンドサーバーとして IP アドレスを追加できます。

    • Fc：関数タイプのサーバーグループです。このタイプのサーバーグループには、バックエンドサーバーとして Function Compute (FC) の関数を追加できます。

    Instance
    VpcId

    string

    任意

    サーバーグループを作成する VPC の ID です。この VPC 内のサーバーのみをサーバーグループに追加できます。

    説明

    このパラメータは、ServerGroupType が Instance または Ip に設定されている場合にのみ有効です。

    vpc-bp15zdkdt37pq72zv****
    Scheduler

    string

    任意

    スケジューリングアルゴリズムです。有効な値：

    • Wrr (デフォルト)：加重ラウンドロビンです。重みの大きいバックエンドサーバーほど、より多くのリクエストを受信します。

    • Wlc：加重最小コネクションです。各バックエンドサーバーの重みとコネクション数に基づいてリクエストが分散されます。2 つのバックエンドサーバーの重みが同じ場合は、コネクション数が少ない方がより多くのリクエストを受信します。

    • Sch：コンシステントハッシュです。同じハッシュ要因のリクエストを同じバックエンドサーバーにルーティングします。デフォルトでは、UchConfig パラメータが設定されていない場合、送信元 IP アドレスがハッシュ要因として使用されます。UchConfig パラメータが設定されている場合、指定した URL パラメータがハッシュ要因として使用されます。

    説明

    このパラメータは、ServerGroupType が Instance または Ip に設定されている場合にのみ有効です。

    Wrr
    Protocol

    string

    任意

    バックエンドプロトコルです。有効な値：

    • HTTP (デフォルト)：サーバーグループを HTTPS、HTTP、および QUIC リスナーに関連付けることができます。

    • HTTPS：サーバーグループを HTTPS リスナーに関連付けることができます。

    • gRPC：サーバーグループを HTTPS および QUIC リスナーに関連付けることができます。

    説明

    ServerGroupType が Fc に設定されている場合、このパラメータを設定する必要はありません。

    HTTP
    ResourceGroupId

    string

    任意

    リソースグループの ID です。

    rg-atstuj3rsop****
    HealthCheckConfig

    object

    必須

    ヘルスチェックの設定です。

    rg-123
    HealthCheckConnectPort

    integer

    任意

    ヘルスチェックに使用するバックエンドサーバーのポートです。

    有効な値：0～65535。

    デフォルト値：0。0 の場合、バックエンドサーバーのトラフィックポートがヘルスチェックに使用されます。

    80
    HealthCheckEnabled

    boolean

    必須

    ヘルスチェック機能を有効にするかどうかを指定します。有効な値：

    • true：ヘルスチェックを有効にします。

    • false：ヘルスチェックを無効にします。

    説明

    ServerGroupType が Instance または Ip に設定されている場合、ヘルスチェックはデフォルトで有効です。ServerGroupType が Fc に設定されている場合、ヘルスチェックはデフォルトで無効です。

    true
    HealthCheckHost

    string

    任意

    ヘルスチェックに使用するドメイン名です。

    • バックエンドサーバーのプライベート IP アドレスを使用 (デフォルト)：バックエンドサーバーのプライベート IP アドレスをヘルスチェックのホスト名として使用します。

    • ドメイン名を指定：特定のドメイン名を入力します。

      • ドメイン名の長さは 1～80 文字である必要があります。

      • 小文字、数字、ハイフン (-)、およびピリオド (.) を含めることができます。

      • 少なくとも 1 つのピリオド (.) を含める必要があります。ピリオド (.) を先頭または末尾の文字にすることはできません。

      • 右端のドメインラベルには英字のみを含めることができ、数字またはハイフン (-) を含めることはできません。

      • ドメイン名はハイフン (-) で始めたり、終えたりすることはできません。

    説明

    このパラメータは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。

    www.example.com
    HealthCheckCodes

    array

    任意

    ヘルスチェックの成功を示す HTTP ステータスコードです。

    string

    任意

    ヘルスチェックが成功した場合の HTTP ステータスコードです。

    • HealthCheckProtocol が HTTP または HTTPS に設定されている場合、次の値を 1 つ以上指定できます：http_2xx (デフォルト)、http_3xx、http_4xx、http_5xx。複数の値はカンマ (,) で区切ります。

    • HealthCheckProtocol が gRPC に設定されている場合、有効なステータスコードは 0～99 です。デフォルト値：0。最大 20 個の値範囲を指定できます。複数の範囲はカンマ (,) で区切ります。

    説明

    このパラメータは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。

    http_2xx
    HealthCheckHttpVersion

    string

    任意

    ヘルスチェックに使用する HTTP バージョンです。有効な値：HTTP1.0 および HTTP1.1。デフォルト値：HTTP1.1。

    説明

    このパラメータは、HealthCheckProtocol が HTTP または HTTPS に設定されている場合にのみ有効です。

    HTTP1.1
    HealthCheckInterval

    integer

    任意

    ヘルスチェックの間隔 (秒) です。

    有効な値：1～50。

    デフォルト値：2。

    2
    HealthCheckMethod

    string

    任意

    ヘルスチェックに使用する HTTP メソッドです。有効な値：

    • GET：レスポンスボディが 8 KB を超える場合、レスポンスは切り詰められます。これはヘルスチェック結果に影響しません。

    • POST：gRPC ヘルスチェックのデフォルトメソッドです。

    • HEAD (デフォルト)：HTTP および HTTPS ヘルスチェックのデフォルトメソッドです。

    説明

    このパラメータは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。

    HEAD
    HealthCheckPath

    string

    任意

    ヘルスチェックのパスです。

    長さは 1～80 文字で、スラッシュ (/) で始まる必要があります。英字、数字、および次の特殊文字を含めることができます：-/.%?#&=、_;~!()*[]@$^:',+。

    説明

    このパラメータは、HealthCheckProtocol が HTTP または HTTPS に設定されている場合にのみ有効です。

    /test/index.html
    HealthCheckProtocol

    string

    任意

    ヘルスチェックに使用するプロトコルです。有効な値：

    • HTTP：HEAD または GET リクエストを送信してブラウザリクエストをシミュレーションし、バックエンドサーバーが正常かどうかを確認します。

    • HTTPS：HEAD または GET リクエストを送信してブラウザリクエストをシミュレーションし、バックエンドサーバーが正常かどうかを確認します。HTTPS はデータが暗号化されるため、より高いセキュリティを提供します。

    • TCP：SYN パケットを送信して、サーバーポートに到達可能かどうかを確認します。

    • gRPC：POST または GET リクエストを送信して、バックエンドサーバーが正常かどうかを確認します。

    HTTP
    HealthCheckTimeout

    integer

    任意

    ヘルスチェックレスポンスのタイムアウト (秒) です。バックエンドサーバーがこの時間内に応答しない場合、ヘルスチェックは失敗します。

    有効な値：1～300。

    デフォルト値：5。

    5
    HealthyThreshold

    integer

    任意

    異常 なバックエンドサーバーが 正常 と見なされるまでに、連続して成功する必要があるヘルスチェックの回数です。

    有効な値：2～10。

    デフォルト値：3。

    3
    UnhealthyThreshold

    integer

    任意

    正常 なバックエンドサーバーが 異常 と見なされるまでに、連続して失敗する必要があるヘルスチェックの回数です。

    有効な値：2～10。

    デフォルト値：3。

    3
    StickySessionConfig

    object

    任意

    スティッキーセッションの設定です。

    説明

    このパラメータは、ServerGroupType が Instance または Ip に設定されている場合にのみ有効です。

    Cookie

    string

    任意

    サーバーに設定される Cookie です。

    Cookie の長さは 1～200 文字で、ASCII 英数字のみ使用できます。カンマ (,) 、セミコロン (;) 、スペースは使用できません。ドル記号 ($) で始めることはできません。

    説明

    StickySessionEnabled が true で、かつ StickySessionType が server の場合、このパラメータは必須です。

    B490B6EBF6F3CD402E515D22BCDA****
    CookieTimeout

    integer

    任意

    Cookie のタイムアウト期間です。単位：秒。

    有効な値：1～86400。

    デフォルト値：1000。

    説明

    StickySessionEnabled が true で、かつ StickySessionType が Insert の場合、このパラメータは必須です。

    1000
    StickySessionEnabled

    boolean

    任意

    スティッキーセッションを有効にするかどうかを指定します。有効な値：

    • true：スティッキーセッションを有効にします。

    • false (デフォルト)：スティッキーセッションを無効にします。

    説明

    このパラメータは、ServerGroupType が Instance または Ip に設定されている場合にのみ有効です。

    false
    StickySessionType

    string

    任意

    Cookie の管理方法です。有効な値：

    • Insert (デフォルト)：Cookie を挿入します。ロードバランサーは、最初のリクエストに対する HTTP または HTTPS レスポンスに Cookie (SERVERID) を挿入します。この Cookie を含む同一クライアントからの後続のリクエストは、同じバックエンドサーバーにルーティングされます。

    • Server：バックエンドサーバーによって生成されるカスタム Cookie を使用します。ロードバランサーは、この Cookie に基づいて同一クライアントからの後続リクエストを同じバックエンドサーバーにルーティングします。

    説明

    StickySessionEnabled が true に設定されている場合、このパラメータは必須です。

    Insert
    ClientToken

    string

    任意

    リクエストのべき等性を確保するために使用されるクライアントトークンです。

    クライアントを使用してトークンを生成できますが、トークンがリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。

    説明

    このパラメータを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。各リクエストの RequestId は異なる場合があります。

    5A2CAF0E-5718-45B5-9D4D-70B******
    DryRun

    boolean

    任意

    ドライランを実行するかどうかを指定します。有効な値：

    • true：ドライランを実行します。システムは、必須パラメータの不足、構文エラー、サービス制限などの問題がないかリクエストを検証しますが、サーバーグループは作成しません。リクエストが無効な場合はエラーメッセージが返されます。リクエストが有効な場合は、DryRunOperation エラーコードが返されます。

    • false (デフォルト)：通常のリクエストを送信します。リクエストがチェックに合格した場合、HTTP 2xx ステータスコードが返され、操作が実行されます。

    false
    Ipv6Enabled

    boolean

    任意

    IPv6 を有効にするかどうかを指定します。

    true
    UpstreamKeepaliveEnabled

    boolean

    任意

    アップストリームキープアライブを有効にするかどうかを指定します。

    • true：アップストリームキープアライブを有効にします。

    • false (デフォルト)：アップストリームキープアライブを無効にします。

    false
    ServiceName

    string

    任意

    このパラメータは ALB Ingress のシナリオでのみ使用できます。サーバーグループに関連付けられている Kubernetes Service の名前を指定します。

    test
    UchConfig

    object

    任意

    URL ベースのコンシステントハッシュの設定です。

    Type

    string

    必須

    パラメータのタイプです。値を QueryString に設定します。

    QueryString
    Value

    string

    必須

    コンシステントハッシュに使用するクエリストリングパラメータのキーです。

    abc
    ConnectionDrainConfig

    object

    任意

    コネクションドレイニングの設定です。

    コネクションドレイニングを有効にすると、バックエンドサーバーが削除された場合、または異常になった場合でも、指定した期間は既存のコネクションの処理が許可されます。

    説明

    • Basic ALB インスタンスはコネクションドレイニングをサポートしていません。この機能は、Standard および WAF-enabled ALB インスタンスでのみサポートされます。

    • コネクションドレイニングはインスタンスタイプおよび IP タイプのサーバーグループでサポートされますが、関数タイプのサーバーグループではサポートされません。

    ConnectionDrainEnabled

    boolean

    任意

    コネクションドレイニングを有効にするかどうかを指定します。

    • true：コネクションドレイニングを有効にします。

    • false (デフォルト)：コネクションドレイニングを無効にします。

    false
    ConnectionDrainTimeout

    integer

    任意

    コネクションドレイニングのタイムアウト (秒) です。

    有効な値：0～900。

    デフォルト値：300。

    300
    SlowStartConfig

    object

    任意

    スロースタートの設定です。

    スロースタートを有効にすると、新たに追加されたバックエンドサーバーに対して、指定した期間にわたってリクエストが徐々に線形にルーティングされます。

    説明

    • Basic ALB インスタンスはスロースタートをサポートしていません。この機能は、Standard および WAF-enabled ALB インスタンスでのみサポートされます。

    • スロースタートはインスタンスタイプおよび IP タイプのサーバーグループでサポートされますが、関数タイプのサーバーグループではサポートされません。

    • スロースタートは、スケジューリングアルゴリズムが Wrr (加重ラウンドロビン) に設定されている場合にのみ有効にできます。

    SlowStartEnabled

    boolean

    任意

    スロースタートを有効にするかどうかを指定します。

    • true：スロースタートを有効にします。

    • false (デフォルト)：スロースタートを無効にします。

    false
    SlowStartDuration

    integer

    任意

    スロースタート期間の長さ (秒) です。

    有効な値：30～900。

    デフォルト値：30。

    30
    Tag

    array<object>

    任意

    タグです。

    object

    任意

    タグです。

    Key

    string

    任意

    タグキーです。キーの長さは最大 128 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。

    env
    Value

    string

    任意

    タグ値です。値の長さは最大 128 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。

    product
    CrossZoneEnabled

    boolean

    任意

    サーバーグループでクロスゾーン負荷分散を有効にするかどうかを指定します。有効な値：

    • true (デフォルト)：クロスゾーン負荷分散を有効にします。

    • false：クロスゾーン負荷分散を無効にします。

    説明

    • Basic ALB インスタンスは、クロスゾーン負荷分散が無効になっているサーバーグループに関連付けることはできません。この機能は、Standard および WAF-enabled ALB インスタンスでのみサポートされます。

    • インスタンスタイプおよび IP タイプのサーバーグループではクロスゾーン負荷分散を無効にできますが、関数タイプのサーバーグループでは無効にできません。

    • クロスゾーン負荷分散を無効にした場合、スティッキーセッションを有効にできません。

    true
    IpVersionAffinityMode

    string

    任意

    サーバーグループの IP バージョンアフィニティモードです。

    Affinity

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    JobId

    string

    非同期タスク ID。

    72dcd26b-f12d-4c27-b3af-18f6aed5****
    RequestId

    string

    リクエスト ID。

    365F4154-92F6-4AE4-92F8-7FF******
    ServerGroupId

    string

    サーバーグループ ID。

    sgp-8ilqs4axp6******

    例

    成功レスポンス

    JSONJSON

    {
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "ServerGroupId": "sgp-8ilqs4axp6******"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 QuotaExceeded.ServerGroupsNum The quota of %s is exceeded, usage %s/%s.
    400 Mismatch.LoadBalancerEditionAndSlowStartEnable The %s and %s are mismatched.
    400 Mismatch.ServerGroupSchedulerAndSlowStartEnable The %s and %s are mismatched.
    400 QuotaExceeded.SlowStartDuration The quota of %s is exceeded, usage %s/%s.
    400 UnsupportedFeature.SlowStart The feature of %s is not supported. The feature of %s is not supported.
    400 Mismatch.LoadBalancerEditionAndConnectionDrain The %s and %s are mismatched.
    400 QuotaExceeded.ConnectionDrainTimeout The quota of %s is exceeded, usage %s/%s.
    400 UnsupportedFeature.ConnectionDrain The feature of %s is not supported.
    400 NotExist.ResourceGroup ResourceGroup does not exist.
    400 OperationDenied.VpcNotSupportIpv6 The operation is not allowed because of VpcNotSupportIpv6.
    400 UnsupportedFeature.FcServerGroup Server groups of type FC are not supported.
    404 ResourceNotFound.Vpc The specified resource %s is not found.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。