すべてのプロダクト
Search

このプロダクト

    Global Accelerator:CreateEndpointGroup

    ドキュメントセンター

    Global Accelerator:CreateEndpointGroup

    最終更新日:Apr 02, 2026

    エンドポイントグループを作成します。

    操作説明

    • レイヤー 4 リスナー用の仮想エンドポイントグループを作成する前に、まずデフォルトのエンドポイントグループを作成する必要があります。

    • CreateEndpointGroup は非同期操作です。リクエストを送信すると、システムはエンドポイントグループ ID を返し、バックグラウンドでエンドポイントグループの作成を開始します。DescribeEndpointGroup を呼び出して、エンドポイントグループのステータスを照会できます。

      • エンドポイントグループが init 状態の場合、作成中です。この状態では、照会操作のみ実行できます。

      • エンドポイントグループが active 状態の場合、作成済みです。

    • 同じ Global Accelerator インスタンスに対して、CreateEndpointGroup 操作を同時に呼び出すことはできません。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ga:CreateEndpointGroup

    create

    *EndpointGroup

    acs:ga:{#regionId}:{#accountId}:endpointgroup/*

    *Listener

    acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

    *Accelerator

    acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}
    • ga:AcceleratorMainland
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    Global Accelerator (GA) インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。

    cn-hangzhou
    ClientToken

    string

    任意

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

    このトークンは生成できますが、各リクエストで一意であることを保証する必要があります。トークンには ASCII 文字のみを含めることができます。

    説明

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

    123e4567-e89b-12d3-a456-426655440000

    AcceleratorId

    string

    必須

    GA インスタンスの ID。

    ga-bp1odcab8tmno0hdq****
    Name

    string

    任意

    エンドポイントグループの名前。

    名前は 1～128 文字の長さで、文字または漢字で始まり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。

    group1
    Description

    string

    任意

    エンドポイントグループの説明。

    説明は最大 200 文字の長さで、http:// または https:// で始めることはできません。

    EndpointGroup
    EndpointGroupRegion

    string

    必須

    エンドポイントグループがデプロイされているリージョンの ID。

    cn-hangzhou
    ListenerId

    string

    必須

    リスナーの ID。

    lsr-bp1bpn0kn908w4nbw****
    TrafficPercentage

    integer

    任意

    リスナーが複数のエンドポイントグループに関連付けられている場合に、エンドポイントグループに分散されるトラフィックの割合。有効値: 1～100。

    20
    HealthCheckIntervalSeconds

    integer

    任意

    ヘルスチェック間隔 (秒単位)。

    3
    HealthCheckPath

    string

    任意

    ヘルスチェックに使用されるパス。

    /healthcheck
    HealthCheckPort

    integer

    任意

    ヘルスチェックに使用されるポート。

    20
    HealthCheckProtocol

    string

    任意

    ヘルスチェックに使用されるプロトコル。有効値:

    • tcp または TCP: TCP

    • http または HTTP: HTTP

    • https または HTTPS: HTTPS

    tcp
    ThresholdCount

    integer

    任意

    エンドポイントのステータスが正常と異常の間で変化するまでに、連続して成功または失敗する必要があるヘルスチェックの回数。有効値: 2～10。デフォルト値: 3。

    3
    EndpointConfigurations

    array<object>

    任意

    エンドポイント構成。

    object

    任意

    エンドポイント構成。

    Type

    string

    必須

    エンドポイントのタイプ。有効値:

    • Domain: カスタムドメイン名。

    • Ip: カスタム IP アドレス。

    • IpTarget: カスタムプライベート IP アドレス。

    • PublicIp: Alibaba Cloud のパブリック IP アドレス。

    • ECS: Elastic Compute Service (ECS) インスタンス。

    • SLB: Server Load Balancer (SLB) インスタンス。

    • ALB: Application Load Balancer (ALB) インスタンス。

    • OSS: Object Storage Service (OSS) バケット。

    • ENI: 弾力性ネットワークインターフェース (ENI)。

    • NLB: Network Load Balancer (NLB) インスタンス。

    説明

    • エンドポイントタイプを ECS、ENI、SLB、ALB、NLB、または IpTarget に設定すると、ロールが存在しない場合、システムは AliyunServiceRoleForGaVpcEndpoint という名前のサービスリンクロールを自動的に作成します。

    • エンドポイントタイプを ALB に設定すると、ロールが存在しない場合、システムは AliyunServiceRoleForGaAlb という名前のサービスリンクロールを自動的に作成します。

    • エンドポイントタイプを OSS に設定すると、ロールが存在しない場合、システムは AliyunServiceRoleForGaOss という名前のサービスリンクロールを自動的に作成します。

    • エンドポイントタイプを NLB に設定すると、ロールが存在しない場合、システムは AliyunServiceRoleForGaNlb という名前のサービスリンクロールを自動的に作成します。

    説明

    詳細については、「サービスリンクロール」をご参照ください。

    Ip
    EnableClientIPPreservation

    boolean

    任意

    クライアントソース IP アドレスを保持するかどうかを指定します。有効値:

    • true: クライアントソース IP アドレスを保持します。

    • false (デフォルト): クライアントソース IP アドレスを保持しません。

    説明

    • デフォルトでは、この機能は TCP または UDP リスナーに関連付けられているエンドポイントグループでは無効になっています。ビジネス要件に基づいてこの機能を有効にできます。

    • デフォルトでは、この機能は HTTP または HTTPS リスナーに関連付けられているエンドポイントグループでは有効になっています。ソース IP アドレスは X-Forwarded-For ヘッダーフィールドから取得されます。この機能は無効にできません。

    • EnableClientIPPreservation と EnableProxyProtocol の両方を true に設定することはできません。

    • 詳細については、「クライアントソース IP アドレスの保持」をご参照ください。

    false
    Weight

    integer

    必須

    エンドポイントの重み。

    有効値: 0～255。

    説明

    エンドポイントの重みを 0 に設定すると、GA はそのエンドポイントへのトラフィックの分散を停止します。注意して進めてください。

    20
    EnableProxyProtocol

    boolean

    任意

    クライアントソース IP アドレスを保持するために PROXY プロトコルを使用するかどうかを指定します。有効値:

    • true: PROXY プロトコルを使用します。

    • false (デフォルト): PROXY プロトコルを使用しません。

    説明

    • このパラメーターは、TCP リスナーに関連付けられているエンドポイントグループに対してのみ構成できます。

    • EnableClientIPPreservation と EnableProxyProtocol の両方を true に設定することはできません。

    • 詳細については、「クライアントソース IP アドレスの保持」をご参照ください。

    false
    Endpoint

    string

    必須

    エンドポイントの IP アドレス、ドメイン名、またはリソース ID。このパラメーターの値は、Type パラメーターの値によって異なります。

    120.1.XX.XX
    SubAddress

    string

    任意

    ENI のプライベート IP アドレス。

    説明

    このパラメーターは、エンドポイントタイプが ENI に設定されている場合にのみ適用されます。このパラメーターを省略すると、ENI のプライマリプライベート IP アドレスが使用されます。

    172.168.X.X
    VpcId

    string

    任意

    Virtual Private Cloud (VPC) の ID。

    インテリジェントルーティングリスナーのエンドポイントグループに対して、最大 1 つの VPC ID を指定できます。

    説明

    このパラメーターは、エンドポイントタイプが IpTarget に設定されている場合にのみ必須です。

    vpc-bp1quce3451z5b2hv****
    VSwitchIds

    array

    任意

    VPC 内の vSwitch のリスト。

    string

    任意

    vSwitch の ID。

    インテリジェントルーティングリスナーのエンドポイントグループに対して、最大 2 つの vSwitch ID を指定できます。

    説明

    このパラメーターは、エンドポイントタイプが IpTarget の場合に必須です。

    • vSwitch は、VpcId パラメーターで指定された VPC に属している必要があります。

    vsw-bp12mho4ze51ezagm****
    Provider

    string

    任意

    AI サービスプロバイダー。Alibaba Cloud Model Studio を使用するには、これを BAILIAN に設定します。

    BAILIAN
    ApiKeys

    array

    任意

    AI サービス用の API キー。

    string

    任意

    AI サービス用の API キー。

    sk-***********
    EndpointRequestProtocol

    string

    任意

    バックエンドサービスで使用されるプロトコル。有効値:

    • HTTP (デフォルト)

    • HTTPS

    説明

    • このパラメーターは、HTTP または HTTPS リスナーのエンドポイントグループに対してのみ利用可能です。

    • HTTP リスナーの場合、バックエンドサービスプロトコルは HTTP である必要があります。

    HTTP
    EndpointProtocolVersion

    string

    任意

    バックエンドサービスプロトコルのバージョン。有効値:

    • HTTP1.1 (デフォルト): HTTP/1.1。

    • HTTP2: HTTP/2。

    説明

    このパラメーターは、EndpointRequestProtocol が HTTPS に設定されている場合にのみ利用可能です。

    HTTP1.1
    EndpointGroupType

    string

    任意

    エンドポイントグループのタイプ。有効値:

    • default (デフォルト): デフォルトのエンドポイントグループ。

    • virtual: 仮想エンドポイントグループ。

    説明

    レイヤー 4 リスナー用の仮想エンドポイントグループを作成する前に、デフォルトのエンドポイントグループを作成していることを確認してください。

    default
    PortOverrides

    array<object>

    任意

    リスナーとエンドポイントのポートマッピング。

    object

    任意

    リスナーとエンドポイントのポートマッピング。

    ListenerPort

    integer

    任意

    ポートマッピングのリスナーポート。

    説明

    • TCP リスナーの場合、仮想エンドポイントグループのポートマッピングを構成することはできません。リスナーが仮想エンドポイントグループに関連付けられている場合、デフォルトのエンドポイントグループのポートマッピングを構成することはできません。デフォルトのエンドポイントグループにポートマッピングが構成されている場合、仮想エンドポイントグループを追加することはできません。

    • ポートマッピングを構成した後、HTTP と HTTPS の切り替えを除き、リスナープロトコルを変更することはできません。

    • リスナーポート範囲を変更する場合、新しい範囲にはポートマッピングで使用されているすべてのリスナーポートを含める必要があります。たとえば、リスナーポート範囲が 80～82 で、リスナーポートがエンドポイントポート 100～102 にマッピングされている場合、リスナーポート範囲を 80～81 に変更することはできません。

    443
    EndpointPort

    integer

    任意

    ポートマッピングのエンドポイントポート。

    80
    HealthCheckEnabled

    boolean

    任意

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

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

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

    true
    Tag

    array<object>

    任意

    エンドポイントグループのタグ。

    object

    任意

    エンドポイントグループのタグ。

    Key

    string

    任意

    タグキー。タグキーは空の文字列にすることはできません。

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

    最大 20 個のタグキーを指定できます。

    test-key
    Value

    string

    任意

    タグ値。タグ値は空の文字列にすることができます。

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

    最大 20 個のタグ値を指定できます。

    test-value
    DryRun

    boolean

    任意

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

    • true: ドライランを実行します。システムは、必須パラメーター、リクエスト形式、およびサービス制限をチェックします。リクエストがドライランに失敗した場合、システムはエラーメッセージを返します。リクエストがドライランに合格した場合、システムは HTTP 2xx 状態コードを返します。

    • false (デフォルト): 通常のリクエストを送信します。リクエストがチェックに合格した場合、システムは HTTP 2xx 状態コードを返し、エンドポイントグループを作成します。

    false
    HealthCheckHost

    string

    任意

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

    www.taobao.com
    EndpointIpVersion

    string

    任意

    バックエンドサービスとの通信に使用される IP バージョン。有効値:

    • IPv4 (デフォルト): GA は IPv4 のみを使用してバックエンドサービスと通信します。

    • IPv6: GA は IPv6 のみを使用してバックエンドサービスと通信します。

    • ProtocolAffinity: GA はクライアントリクエストと同じ IP バージョンを使用してバックエンドサービスと通信します。

    IPv4

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    EndpointGroupId

    string

    エンドポイントグループ ID。

    epg-bp1dmlohjjz4kqaun****
    RequestId

    string

    リクエスト ID。

    04F0F334-1335-436C-A1D7-6C044FE73368

    例

    成功レスポンス

    JSONJSON

    {
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Domain.NotFit The domain is not fit the rule
    400 Resource.QuotaFull The resource quota is exceeded.
    400 NotExist.ListenerPort The listening port %s does not exist.
    400 NoPermission.EnableHealthCheck You do not have permission to enable health check.
    400 NotExist.Listener The listener does not exist. The listener does not exist.
    400 NotActive.Listener The state of the listener is not active. The state of the listener is not active.
    400 NotExist.Accelerator The accelerated instance does not exist. The accelerated instance does not exist.
    400 StateError.Accelerator The state of the accelerated instance is invalid.
    400 NotExist.BusinessRegion The business region does not exist. The business region does not exist.
    400 NotExist.BasicBandwidthPackage You must specify the basic bandwidth package. You must specify the basic bandwidth package.
    400 QuotaExceeded.EndPoint The maximum number of endpoints is exceeded. The maximum number of endpoints is exceeded.
    400 Exist.EndpointGroup The endpoint group already exists.
    400 NoPermission.VpcEndpoint You are not authorized to perform the operation.
    400 EndPointRequestProtocolIllegal.EndpointGroup endpoint group request protoco is illegal
    400 QuotaExceeded.PortOverride The number of port override exceeds the limit.
    500 UnknownError An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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

    変更履歴

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