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

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

操作説明

使用上の注意

UpdateEndpointGroups 操作は非同期です。システムはリクエスト ID を返しますが、エンドポイントグループの構成はすぐには更新されません。更新タスクはバックグラウンドで実行され続けます。 DescribeEndpointGroup または ListEndpointGroups 操作を呼び出して、エンドポイントグループのステータスをクエリできます。
- エンドポイントグループが updating 状態の場合、エンドポイントグループの構成が更新中です。この状態では、クエリ操作のみを実行することが可能です。
- エンドポイントグループがアクティブな状態の場合、エンドポイントグループの構成が更新されています。
UpdateEndpointGroups 操作は、同じ Alibaba Cloud Global Accelerator (GA) インスタンス内のエンドポイントグループ構成の同時更新をサポートしていません。

今すぐお試しください

この 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	必須	Alibaba Cloud Global Accelerator (GA) インスタンスのリージョン ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみ使用できます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。各 API リクエストの RequestId は一意です。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: ドライランを実行します。システムはエンドポイントグループを更新せずにリクエストをチェックします。必須パラメーターが指定されているか、リクエストフォーマットが有効か、サービス制限を満たしているかがチェックされます。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに合格した場合、HTTP 2xx 状態コードが返されます。 false (デフォルト): ドライランを実行し、その後リクエストを送信します。リクエストがドライランに合格した場合、HTTP 2xx 状態コードが返され、システムはエンドポイントグループを更新します。	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 ECS インスタンス。 SLB: Alibaba Cloud SLB インスタンス。 ALB: Alibaba Cloud ALB インスタンス。 OSS: Alibaba Cloud OSS インスタンス。 ENI: Alibaba Cloud エラスティックネットワークインターフェース (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	任意	エラスティックネットワークインターフェース (ENI) の非公開 IP アドレス。説明エンドポイントタイプが ENI の場合、このパラメーターを指定できます。このパラメーターを指定しない場合、デフォルトで ENI のプライマリ非公開 IP アドレスが使用されます。	172.168.XX.XX
EnableClientIPPreservation	boolean	任意	自動取得メソッドを使用してクライアント IP アドレスのリストの保持を有効にするかどうかを指定します。有効な値とフォーマット: true: クライアント IP アドレスの保持を有効にします。 false (デフォルト): クライアント IP アドレスの保持を無効にします。説明デフォルトでは、UDP または TCP リスナーに関連付けられたエンドポイントグループでは、クライアント IP アドレスの保持は無効になっています。ビジネス要件に基づいてこの特徴をセットできます。デフォルトでは、HTTP または HTTPS リスナーに関連付けられたエンドポイントグループでは、クライアント IP アドレスの保持は有効になっています。クライアント IP アドレスは X-Forwarded-For ヘッダーから取得されます。この特徴を無効にすることはできません。 EnableClientIPPreservation と EnableProxyProtocol の両方を true にセットすることはできません。詳細については、「クライアント IP アドレスの保持」を参照してください。
EnableProxyProtocol	boolean	任意	Proxy Protocol を使用してクライアント IP アドレスのリストの保持を有効にするかどうかを指定します。有効な値とフォーマット: true: クライアント IP アドレスの保持を有効にします。 false (デフォルト): クライアント IP アドレスの保持を無効にします。説明このパラメーターは、TCP リスナーに関連付けられたエンドポイントグループでのみサポートされています。 EnableClientIPPreservation と EnableProxyProtocol の両方を true にセットすることはできません。詳細については、「クライアント IP アドレスの保持」を参照してください。
VpcId	string	任意	仮想非公開クラウド (VPC) の ID。インテリジェントルーティングリスナーに関連付けられたエンドポイントグループのリストに対して、VPC ID は最大 1 つまで指定できます。説明このパラメーターは、エンドポイントタイプが IpTarget にセットされている場合にのみ必須であり、効果があります。	vpc-uf66oesmrqge1t2gs****
VSwitchIds	array	任意	VPC 内の vSwitch。
	string	任意	vSwitch の ID。インテリジェントルーティングリスナーに関連付けられたエンドポイントグループのリストに対して、vSwitch ID は最大 2 つまで指定できます。説明このパラメーターは、エンドポイントタイプが IpTarget にセットされている場合にのみ必須であり、効果があります。 vSwitch は、VpcId パラメーターで指定された VPC に属している必要があります。	vsw-uf6r0due94mypz1i9****
Provider	string	任意	エンドポイント構成のサービスプロバイダー。	BAILIAN
ApiKeys	array	任意	エンドポイントグループ構成内の API キー。
	string	任意	エンドポイントグループ構成内の API キー。	sk-*******
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 リスナーのリストの場合: 仮想エンドポイントグループではポートマッピングはサポートされていません。リスナー配下に仮想エンドポイントグループが既に存在する場合、デフォルトのエンドポイントグループに対してポートマッピングをセットすることはできません。デフォルトのエンドポイントグループに対してポートマッピングが既にセットされている場合、仮想エンドポイントグループを追加することはできません。ポートマッピングをセットした後、後続のリスナー変更には以下の制限が適用されます: HTTP と HTTPS の切り替えを除き、リスナープロトコルを変更することはできません。リスナーポート: 変更済みのリスナーポート範囲には、現在のポートマッピングでセットされているすべてのリスナーポートが含まれている必要があります。たとえば、リスナーポート範囲が 80～82 で、エンドポイントポート 100～102 にポートマッピングがセットされている場合、リスナーポート範囲を 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	任意	ヘルスチェック用のドメイン名。	www.taobao.com
EndpointIpVersion	string	任意	バックエンドサービスの IP バージョン。有効な値: IPv4 (デフォルト): GA は IPv4 アドレスを使用してのみエンドポイントサービスと通信します。 IPv6: GA は IPv6 アドレスを使用してのみエンドポイントサービスと通信します。 ProtocolAffinity: GA は、クライアントリクエストで使用された IP バージョンと同じ IP バージョンを使用してエンドポイントサービスと通信します。	IPv4
ProxyTunnel	object	任意	プロキシトンネル構成。
ConnectAuthPrefix	string	任意	プロキシトンネル接続認証プレフィックス。	prefix-auth
ConnectAuthSuffix	string	任意	プロキシトンネル接続認証サフィックス。	suffix-auth
ConnectSessionHashHdr	string	任意	接続会話ハッシュヘッダー構成。	X-Session-Hash
ConnectTunnelTimeout	integer	任意	プロキシトンネル接続タイムアウト期間。	5000
TunnelServerPort	integer	任意	トンネルサーバーポート。	8443
TunnelServerType	string	任意	トンネルサーバータイプ。	domain
TunnelServer	string	任意	トンネルサーバー構成。	tunnel.example.com
HealthCheckMethod	string	任意	エンドポイントグループのヘルスチェックメソッド。	GET
HealthCheckSuccessCodes	string	任意	ヘルスチェックの成功状態コード。	http_2xx,http_3xx
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

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

変更履歴

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