すべてのプロダクト
Search
ドキュメントセンター

:UpdateEndpointGroup

最終更新日:Dec 25, 2025

エンドポイントグループの構成を変更します。

操作説明

  • UpdateEndpointGroup は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返しますが、操作はバックグラウンドで実行され続けます。DescribeEndpointGroup を呼び出して、エンドポイントグループの状態をクエリできます。
    • エンドポイントグループが updating 状態の場合、その構成は変更中です。この状態では、クエリ操作のみを実行できます。

    • エンドポイントグループが active 状態の場合、その構成は変更されています。

  • 同じ Global Accelerator インスタンス内のエンドポイントグループの構成を変更するために、UpdateEndpointGroup を同時に呼び出すことはできません。

今すぐお試しください

この 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:UpdateEndpointGroup

update

*EndpointGroup

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

Global Accelerator インスタンスのリージョン ID。値を cn-hangzhou に設定します。

cn-hangzhou

ClientToken

string

任意

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

クライアントからパラメーター値を生成して、異なるリクエスト間で値が一意になるようにします。トークンには ASCII 文字のみを含めることができます。

説明

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

123e4567-e89b-12d3-a456-426655440000

EndpointGroupId

string

必須

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

epg-bp1dmlohjjz4kqaun****

Name

string

任意

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

名前は 1~128 文字で、先頭は英字または漢字である必要があります。数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。

group1

Description

string

任意

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

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

EndpointGroup

EndpointGroupRegion

string

必須

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

cn-hangzhou

TrafficPercentage

integer

任意

エンドポイントグループの重み。リスナーが複数のエンドポイントグループに関連付けられている場合、トラフィックは重みに基づいてエンドポイントグループに分散されます。

20

HealthCheckIntervalSeconds

integer

任意

2 つの連続したヘルスチェックの間隔。単位:秒。有効値:150

3

HealthCheckPath

string

任意

ヘルスチェックのパス。

/healthcheck

HealthCheckPort

integer

任意

ヘルスチェックに使用されるポート。有効値:165535

20

HealthCheckProtocol

string

任意

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

  • tcp または TCP:TCP

  • http または HTTP:HTTP

  • https または HTTPS:HTTPS

HTTPS

ThresholdCount

integer

任意

正常なエンドポイントが異常と見なされるまでに発生する必要がある連続したヘルスチェックの失敗回数、または異常なエンドポイントが正常と見なされるまでに発生する必要がある連続したヘルスチェックの成功回数。

有効値:210

3

EndpointConfigurations

array<object>

任意

エンドポイントの構成。

object

任意

エンドポイントの構成。

Type

string

必須

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

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

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

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

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

  • ECS:Alibaba Cloud ECS インスタンス。

  • SLB:Alibaba Cloud SLB インスタンス。

  • ALB:Alibaba Cloud ALB インスタンス。

  • OSS:Alibaba Cloud OSS インスタンス。

  • ENI:Alibaba Cloud ENI。

  • NLB:Alibaba Cloud NLB インスタンス。

説明
  • エンドポイントタイプを ECSENISLBALBNLB、または IpTarget に設定し、サービスリンクロール AliyunServiceRoleForGaVpcEndpoint が存在しない場合、システムは自動的にサービスリンクロールを作成します。

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

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

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

説明

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

Ip

EnableClientIPPreservation

boolean

任意

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

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

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

説明
  • デフォルトでは、UDP および TCP リスナーのエンドポイントグループでは、クライアント IP の保持は無効になっています。必要に応じて有効にできます。

  • デフォルトでは、HTTP および HTTPS リスナーのエンドポイントグループでは、クライアント IP の保持は有効になっています。クライアント IP アドレスは X-Forwarded-For ヘッダーから取得されます。この機能を無効にすることはできません。

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

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

false

Weight

integer

必須

エンドポイントの重み。

有効値:0255

説明

エンドポイントの重みを 0 に設定すると、Global Accelerator はそのエンドポイントへのトラフィックの分散を停止します。取り扱いにはご注意ください。

20

EnableProxyProtocol

boolean

任意

プロキシプロトコルを使用してクライアント IP アドレスを保持するかどうかを指定します。有効な値:

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

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

説明
  • このパラメーターは、TCP リスナーのエンドポイントグループでのみ使用できます。

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

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

false

Endpoint

string

必須

Type の値に基づく、エンドポイントの IP アドレス、ドメイン名、またはインスタンス ID。

120.XX.XX.21

SubAddress

string

任意

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

説明

このパラメーターは、エンドポイントタイプが ENI の場合にのみ使用できます。このパラメーターを指定しない場合、ENI のプライマリプライベート IP アドレスが使用されます。

172.168.XX.XX

VpcId

string

任意

VPC の ID。

スマートルーティングを使用するリスナーに関連付けられているエンドポイントグループには、最大 1 つの VPC ID を指定できます。

説明

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

vpc-2zen6t0u7xhm0k5iz****

VSwitchIds

array

任意

VPC 内の vSwitch。

string

任意

vSwitch の ID。

スマートルーティングを使用するリスナーに関連付けられているエンドポイントグループには、最大 2 つの vSwitch ID を指定できます。

説明

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

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

vsw-2ze2dbtkxabpvpqxc****

EndpointRequestProtocol

string

任意

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

  • HTTP

  • HTTPS

説明
  • このパラメーターは、HTTP または HTTPS リスナーのエンドポイントグループを作成する場合にのみ使用できます。

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

HTTP

EndpointProtocolVersion

string

任意

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

  • HTTP1.1

  • HTTP2

説明

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

HTTP1.1

PortOverrides

array<object>

任意

ポートマッピング。

object

任意

ポートマッピング。

ListenerPort

integer

任意

エンドポイントポートにマッピングされるリスナーポート。

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

  • ポートマッピングを設定した後、リスナーを変更する際には次の制限が適用されます:HTTP と HTTPS の切り替えを除き、リスナープロトコルを変更することはできません。

  • リスナーポート:変更後のリスナーポート範囲には、既存のポートマッピングで設定されているすべてのリスナーポートが含まれている必要があります。たとえば、現在のリスナーポート範囲が 80-82 で、リスナーポート 80、81、82 をエンドポイントポート 100、101、102 にマッピングしている場合、リスナーポート範囲を 80-81 に変更することはできません。

443

EndpointPort

integer

任意

リスナーポートがマッピングされるエンドポイントポート。

80

HealthCheckEnabled

boolean

任意

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

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

  • false (デフォルト):ヘルスチェック機能を無効にします。

true

HealthCheckHost

string

任意

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

www.taobao.com

レスポンスフィールド

フィールド

説明

object

返されたデータ。

RequestId

string

リクエスト ID。

6FEA0CF3-D3B9-43E5-A304-D217037876A8

成功レスポンス

JSONJSON

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 NoPermission.EnableHealthCheck You do not have permission to enable health check.
400 NotExist.EndPointGroup The endpoint group does not exist. The endpoint group does not exist.
400 StateError.EndPointGroup The specified state of endpoint group is invalid. The specified state of endpoint group is invalid.
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 QuotaExceeded.EndPoint The maximum number of endpoints is exceeded. The maximum number of endpoints is exceeded.
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.
400 NotExist.ListenerPort listener port %s is not exist

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

変更履歴

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