UpdateEndpointGroups - - Alibaba Cloud ドキュメントセンター

リスナーのエンドポイントグループをバッチで変更します。

操作説明

UpdateEndpointGroups は非同期操作です。リクエストを送信すると、リクエスト ID が返されますが、操作はバックグラウンドで実行され続けます。 DescribeEndpointGroup または ListEndpointGroups 操作を呼び出して、エンドポイントグループの状態をクエリできます。
- エンドポイントグループが updating 状態の場合、その構成は変更中です。この状態では、クエリ操作のみを実行できます。
- エンドポイントグループが active 状態の場合、その構成は変更されています。
同じ Global Accelerator インスタンスに属するエンドポイントグループの構成を変更するために、UpdateEndpointGroups 操作を同時に呼び出すことはできません。

今すぐお試しください

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

update

*EndpointGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Global Accelerator インスタンスが配置されているリージョン ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントでパラメーター値を生成し、異なるリクエスト間で一意であることを確認してください。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエストの RequestId を ClientToken として使用します。 RequestId はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効値： true：ドライランを実行します。システムは、必須パラメーター、リクエストフォーマット、およびサービス制限をチェックします。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに成功した場合、2xx HTTP ステータスコードが返されます。 false (デフォルト)：リクエストを送信します。リクエストがチェックに合格すると、2xx HTTP ステータスコードが返され、操作が実行されます。	true
EndpointGroupConfigurations	array<object>	必須	エンドポイントグループの構成。
	array<object>	任意	エンドポイントグループの構成。
EndpointGroupName	string	任意	エンドポイントグループの名前。名前は 1～128 文字で、英字または漢字で始まる必要があり、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。	group1
EndpointGroupDescription	string	任意	エンドポイントグループの説明。説明は最大 200 文字で、http:// または https:// で始めることはできません。	group1
TrafficPercentage	integer	任意	トラフィック分散比率。リスナーが複数のエンドポイントグループに関連付けられている場合、このパラメーターを指定してトラフィックをエンドポイントグループに分散できます。有効値：1～100。	20
HealthCheckEnabled	boolean	任意	ヘルスチェック機能を有効にするかどうかを指定します。 true：ヘルスチェック機能を有効にします。 false (デフォルト)：ヘルスチェック機能を無効にします。	true
HealthCheckIntervalSeconds	integer	任意	2 回の連続したヘルスチェックの間隔。単位：秒。有効値：1～50。	3
HealthCheckPath	string	任意	ヘルスチェックのパス。	/healthcheck
HealthCheckPort	integer	任意	ヘルスチェックに使用されるポート。有効値：1～65535。	20
HealthCheckProtocol	string	任意	ヘルスチェックに使用されるプロトコル。 tcp または TCP：TCP http または HTTP：HTTP https または HTTPS：HTTPS	tcp
ThresholdCount	integer	任意	エンドポイントが正常と見なされるために合格する必要がある、または異常と見なされるために失敗する必要がある連続したヘルスチェックの回数。有効値：2～10。	3
EndpointConfigurations	array<object>	任意	エンドポイントの構成。
	object	必須	エンドポイントの構成。
Type	string	必須	エンドポイントのタイプ。 Domain：カスタムドメイン名。 Ip：カスタム IP アドレス。 IpTarget：カスタムプライベート IP アドレス。 PublicIp：Alibaba Cloud パブリック IP アドレス。 ECS：Alibaba Cloud Elastic Compute Service (ECS) インスタンス。 SLB：Alibaba Cloud Server Load Balancer (SLB) インスタンス。 ALB：Alibaba Cloud Application Load Balancer (ALB) インスタンス。 OSS：Alibaba Cloud Object Storage Service (OSS) バケット。 ENI：Alibaba Cloud Elastic Network Interface (ENI)。 NLB：Alibaba Cloud Network Load Balancer (NLB) インスタンス。説明エンドポイントタイプを ECS、ENI、SLB、NLB、または IpTarget に設定し、サービスリンクロールが存在しない場合、システムは AliyunServiceRoleForGaVpcEndpoint という名前のサービスリンクロールを自動的に作成します。エンドポイントタイプを ALB に設定し、サービスリンクロールが存在しない場合、システムは AliyunServiceRoleForGaAlb という名前のサービスリンクロールを自動的に作成します。エンドポイントタイプを OSS に設定し、サービスリンクロールが存在しない場合、システムは AliyunServiceRoleForGaOss という名前のサービスリンクロールを自動的に作成します。説明詳細については、「サービスリンクロール」をご参照ください。	Ip
Weight	integer	必須	エンドポイントの重み。有効値：0～255。説明エンドポイントの重みを 0 に設定すると、Global Accelerator はそのエンドポイントへのトラフィックの転送を停止します。この操作は慎重に行ってください。	20
Endpoint	string	必須	Type の値に基づく、エンドポイントの IP アドレス、ドメイン名、またはインスタンス ID。	47.0.XX.XX
SubAddress	string	任意	ENI のプライベート IP アドレス。説明このパラメーターは、エンドポイントタイプが ENI の場合にのみ使用できます。このパラメーターは指定できます。このパラメーターを指定しない場合、ENI のプライマリプライベート IP アドレスが使用されます。	172.168.XX.XX
EnableClientIPPreservation	boolean	任意	クライアント IP の保持を有効にするかどうかを指定します。有効値： true：クライアント IP を保持します。 false (デフォルト)：クライアント IP を保持しません。説明デフォルトでは、TCP および UDP リスナーのエンドポイントグループに対してクライアント IP の保持は無効になっています。ビジネスニーズに基づいて有効にすることができます。 HTTP および HTTPS リスナーのエンドポイントグループでは、クライアント IP の保持がデフォルトで有効になっています。クライアント IP アドレスは X-Forwarded-For ヘッダーフィールドから取得されます。この機能を無効にすることはできません。 EnableClientIPPreservation と EnableProxyProtocol を同時に true に設定することはできません。詳細については、「クライアント IP の保持」をご参照ください。
EnableProxyProtocol	boolean	任意	クライアント IP アドレスを保持するために Proxy Protocol を使用するかどうかを指定します。有効値： true：Proxy Protocol を使用します。 false (デフォルト)：Proxy Protocol を使用しません。説明このパラメーターは、TCP リスナーのエンドポイントグループでのみ使用できます。 EnableClientIPPreservation と EnableProxyProtocol を同時に true に設定することはできません。詳細については、「クライアント IP の保持」をご参照ください。
VpcId	string	任意	VPC (Virtual Private Cloud) の ID。スマートルーティングを使用するリスナーに関連付けられているエンドポイントグループには、最大 1 つの VPC ID を指定できます。説明このパラメーターは必須であり、エンドポイントタイプが IpTarget の場合にのみ有効です。	vpc-uf66oesmrqge1t2gs****
VSwitchIds	array	任意	VPC 内の vSwitch のリスト。
	string	任意	vSwitch の ID。スマートルーティングを使用するリスナーに関連付けられているエンドポイントグループには、最大 2 つの vSwitch ID を指定できます。説明このパラメーターは必須であり、エンドポイントタイプが IpTarget の場合にのみ有効です。 vSwitch は、VpcId パラメーターで指定された VPC に属している必要があります。	vsw-uf6r0due94mypz1i9****
EndpointRequestProtocol	string	任意	バックエンドサービスのプロトコル。有効値： HTTP：HTTP HTTPS：HTTPS 説明このパラメーターは、HTTP または HTTPS リスナーのエンドポイントグループを作成する場合にのみ設定できます。 HTTP リスナーの場合、バックエンドサービスプロトコルは HTTP である必要があります。	HTTP
EndpointProtocolVersion	string	任意	スマートルーティングを使用するリスナーのエンドポイントのバックエンドサービスプロトコルのバージョン。有効値： HTTP1.1 (デフォルト)：HTTP/1.1 HTTP2：HTTP/2 説明このパラメーターは、EndpointRequestProtocol を HTTPS に設定した場合にのみ使用できます。	HTTP1.1
PortOverrides	array<object>	任意	ポートマッピング。
	object	任意	ポートマッピング。
ListenerPort	integer	任意	リスナーポート。有効値：1～65499。説明 TCP リスナーの場合、仮想エンドポイントグループはポートマッピングをサポートしません。リスナーの下に仮想エンドポイントグループが既に存在する場合、デフォルトのエンドポイントグループにポートマッピングを設定することはできません。デフォルトのエンドpointグループにポートマッピングが既に設定されている場合、仮想エンドポイントグループを追加することはできません。ポートマッピングを設定した後、以降のリスナーの変更には次の制限が適用されます：HTTP と HTTPS の間での変更を除き、リスナープロトコルを変更することはできません。リスナーポート：変更後のリスナーポート範囲には、現在マッピングされているすべてのリスナーポートが含まれている必要があります。たとえば、リスナーポート範囲が 80～82 で、ポートがエンドポイントポート 100～102 にマッピングされている場合、リスナーポート範囲を 80～81 に変更することはできません。	443
EndpointPort	integer	任意	エンドポイントポート。有効値：1～65499。	80
EnableClientIPPreservationToa	boolean	任意	クライアント IP アドレスを保持するために TCP Option Address (TOA) モジュールを使用するかどうかを指定します。有効値： true：はい。 false：いいえ。	false
EnableClientIPPreservationProxyProtocol	boolean	任意	クライアント IP アドレスを保持するために Proxy Protocol を使用するかどうかを指定します。有効値： true：はい。 false：いいえ。	false
EndpointGroupId	string	必須	エンドポイントグループの ID。	ep-bp1d2utp8qqe2a44t****
HealthCheckHost	string	任意
ListenerId	string	必須	リスナーの ID。	lsr-bp1bpn0kn908w4nbw****

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	エンドポイントグループの ID。
	string	エンドpointグループの ID。	epg-bp1dmlohjjz4kqaun****

例

成功レスポンス

JSONJSON

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "EndpointGroupIds": [
    "epg-bp1dmlohjjz4kqaun****"
  ]
}

エラーコード

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

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

変更履歴

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