概要 - Global Accelerator (GA) - Alibaba Cloud - - Alibaba Cloud ドキュメントセンター

リスナーの複数のエンドポイントグループを更新します。

操作説明

使用方法

UpdateEndpointGroups は非同期 API です。リクエストを送信すると、システムはリクエスト ID を返し、バックグラウンドで更新を実行します。DescribeEndpointGroup または ListEndpointGroups を呼び出して、エンドポイントグループのステータスをクエリできます。
- エンドポイントグループが updating 状態の場合、クエリのみ実行できます。
- エンドポイントグループが active 状態になると、更新は完了です。
UpdateEndpointGroups 操作を使用して、同じ Global Accelerator インスタンスに属するエンドポイントグループを同時に更新することはできません。

今すぐお試しください

この 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	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントからトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。`ClientToken` には 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	任意	ヘルスチェックの間隔。単位：秒。有効値：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 ECS インスタンス。 SLB：Alibaba Cloud SLB インスタンス。 ALB：Alibaba Cloud ALB インスタンス。 OSS：Alibaba Cloud OSS インスタンス。 ENI：Alibaba Cloud Elastic Network Interface (ENI)。 NLB：Alibaba Cloud NLB インスタンス。説明エンドポイントタイプが ECS、ENI、SLB、ALB、NLB、または IpTarget で、必要なサービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaVpcEndpoint という名前のサービスリンクロールを作成します。エンドポイントタイプが ALB で、必要なサービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaAlb という名前のサービスリンクロールを作成します。エンドポイントタイプが OSS で、必要なサービスリンクロールが存在しない場合、システムは自動的に AliyunServiceRoleForGaOss という名前のサービスリンクロールを作成します。説明詳細については、「サービスリンクロール」をご参照ください。	Ip
Weight	integer	必須	エンドポイントの重み。有効値：0～255。説明エンドポイントの重みを 0 に設定すると、Global Accelerator はそのエンドポイントへのトラフィックのルーティングを停止します。この設定は注意して使用してください。	20
Endpoint	string	必須	エンドポイントタイプに対応する IP アドレス、ドメイン名、またはインスタンス ID。	47.0.XX.XX
SubAddress	string	任意	Elastic Network Interface (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	任意	Proxy Protocol を使用してクライアント IP アドレスを維持するかどうかを指定します。有効値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。説明このパラメーターは、TCP リスナーのエンドポイントグループでのみサポートされます。 `EnableClientIPPreservation` と `EnableProxyProtocol` の両方を `true` に設定することはできません。詳細については、「クライアント IP アドレスの維持」をご参照ください。
VpcId	string	任意	VPC の ID。インテリジェントルーティングリスナーに関連付けられている各エンドポイントグループには、1 つの VPC ID のみ指定できます。説明このパラメーターは、エンドポイントタイプが IpTarget の場合にのみ必須です。	vpc-uf66oesmrqge1t2gs****
VSwitchIds	array	任意	VPC 内の vSwitch の ID。
	string	任意	vSwitch の ID。インテリジェントルーティングリスナーに関連付けられている各エンドポイントグループには、最大 2 つの vSwitch ID を指定できます。説明このパラメーターは、エンドポイントタイプが IpTarget の場合にのみ必須です。 vSwitch は、VpcId パラメーターで指定された VPC に属している必要があります。	vsw-uf6r0due94mypz1i9****
Provider	string	任意		BAILIAN
ApiKeys	array	任意
	string	任意		sk-*******
EndpointRequestProtocol	string	任意	バックエンドプロトコル。有効値： HTTP HTTPS 説明このパラメーターは、HTTP または HTTPS リスナーのエンドポイントグループでのみサポートされます。 HTTP リスナーの場合、バックエンドプロトコルは HTTP である必要があります。	HTTP
EndpointProtocolVersion	string	任意	インテリジェントルーティングリスナーに関連付けられているエンドポイントのバックエンドプロトコルのバージョン。有効値： HTTP1.1 (デフォルト) HTTP2 説明このパラメーターは、`EndpointRequestProtocol` パラメーターが `HTTPS` に設定されている場合にのみ設定できます。	HTTP1.1
PortOverrides	array<object>	任意	ポートマッピング。
	object	任意	ポートマッピング。
ListenerPort	integer	任意	リスナーポート。有効値：1～65499。説明 TCP リスナーの場合、仮想エンドポイントグループはポートマッピングをサポートしていません。リスナーに仮想エンドポイントグループが既に存在する場合、デフォルトのエンドポイントグループにポートマッピングを設定することはできません。デフォルトのエンドポイントグループにポートマッピングが既に設定されている場合、仮想エンドポイントグループを追加することはできません。ポートマッピングを設定した後、HTTP と HTTPS の切り替えを除き、リスナープロトコルを変更することはできません。リスナーポート範囲を変更する場合、新しい範囲にはポートマッピングで指定されているすべてのリスナーポートが含まれている必要があります。たとえば、リスナーポート範囲が 80～82 で、この範囲にポートマッピングが設定されている場合、リスナーポート範囲を 80～81 に変更することはできません。	443
EndpointPort	integer	任意	エンドポイントポート。有効値：1～65499。	80
EnableClientIPPreservationToa	boolean	任意	TCP Option Address (TOA) モジュールを使用してクライアント IP アドレスを維持するかどうかを指定します。有効値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。	false
EnableClientIPPreservationProxyProtocol	boolean	任意	Proxy Protocol を使用してクライアント IP アドレスを維持するかどうかを指定します。有効値： true：この機能を有効にします。 false (デフォルト)：この機能を無効にします。	false
EndpointGroupId	string	必須	エンドポイントグループの ID。	ep-bp1d2utp8qqe2a44t****
HealthCheckHost	string	任意	ヘルスチェックに使用されるドメイン名。
EndpointIpVersion	string	任意	エンドポイントの IP バージョン。このパラメーターは、エンドポイントタイプが `Domain<ept></ept>` の場合にのみ使用できます。
ListenerId	string	必須	リスナーの ID。	lsr-bp1bpn0kn908w4nbw****

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
RequestId	string	リクエストの ID。	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	エンドポイントグループの ID。
	string	エンドポイントグループの 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

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

変更履歴

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