UpdateEndpointGroup API でエンドポイントグループ設定を更新する - Global Accelerator - Alibaba Cloud - Global Accelerator

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

操作説明

UpdateEndpointGroup API は非同期 API です。この API を呼び出すと、システムはリクエスト ID を返し、バックグラウンドで更新を開始します。構成はすぐには変更されません。DescribeEndpointGroup を呼び出して、エンドポイントグループのステータスを確認します。
- エンドポイントグループが updating ステータスの場合、その構成は変更中であり、クエリ操作のみ実行できます。
- エンドポイントグループが active ステータスの場合、更新は完了しています。
UpdateEndpointGroup API は、同じ 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:UpdateEndpointGroup

update

*EndpointGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Global Accelerator インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するためにクライアントが生成するトークンです。トークンはリクエスト間で一意である必要があり、ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は API リクエストごとに一意です。	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	任意	ヘルスチェックの間隔 (秒)。有効な値：1～50。	3
HealthCheckPath	string	任意	ヘルスチェックのパス。	/healthcheck
HealthCheckPort	integer	任意	ヘルスチェックに使用されるポート。有効な値：1～65535。	20
HealthCheckProtocol	string	任意	ヘルスチェックのプロトコル。有効な値： tcp または TCP http または HTTP https または HTTPS	HTTPS
ThresholdCount	integer	任意	エンドポイントのヘルスステータスを変更するために必要な、連続した成功または失敗したヘルスチェックの回数。有効な値：2～10。	3
EndpointConfigurations	array<object>	任意	エンドポイントの構成。
	object	任意	エンドポイントの構成。
Type	string	必須	エンドポイントのタイプ。有効な値： Domain：カスタムドメイン名。 Ip：カスタム IP アドレス。 IpTarget：カスタムプライベート IP アドレス。 PublicIp：Alibaba Cloud パブリック IP アドレス。 ECS：ECS インスタンス。 SLB：SLB インスタンス。 ALB：ALB インスタンス。 OSS：OSS インスタンス。 ENI：ENI (Elastic Network Interface)。 NLB：NLB インスタンス。説明エンドポイントタイプが ECS、ENI、SLB、または IpTarget で、サービスリンクロールが存在しない場合、システムは AliyunServiceRoleForGaVpcEndpoint という名前のサービスリンクロールを自動的に作成します。エンドポイントタイプが ALB で、サービスリンクロールが存在しない場合、システムは AliyunServiceRoleForGaAlb という名前のサービスリンクロールを自動的に作成します。エンドポイントタイプが OSS で、サービスリンクロールが存在しない場合、システムは AliyunServiceRoleForGaOss という名前のサービスリンクロールを自動的に作成します。エンドポイントタイプが NLB で、サービスリンクロールが存在しない場合、システムは AliyunServiceRoleForGaNlb という名前のサービスリンクロールを自動的に作成します。説明詳細については、「サービスリンクロール」をご参照ください。	Ip
EnableClientIPPreservation	boolean	任意	クライアントソース IP アドレスを保持するかどうかを指定します。有効な値： true：クライアントソース IP アドレスを保持します。 false (デフォルト)：クライアントソース IP アドレスを保持しません。説明 TCP または UDP リスナーのエンドポイントグループでは、この機能はデフォルトで無効になっていますが、必要に応じて有効にできます。 HTTP または HTTPS リスナーのエンドポイントグループでは、クライアントソース IP アドレスはデフォルトで保持されます。クライアント IP アドレスは X-Forwarded-For ヘッダーから取得されます。この機能を無効にすることはできません。 `EnableClientIPPreservation` と `EnableProxyProtocol` の両方を `true` に設定することはできません。詳細については、「クライアントソース IP アドレスの保持」をご参照ください。	false
Weight	integer	必須	エンドポイントの重み。有効な値：0～255。説明エンドポイントの重みを 0 に設定すると、Global Accelerator はそのエンドポイントへのトラフィックの配信を停止します。操作には注意が必要です。	20
EnableProxyProtocol	boolean	任意	Proxy Protocol を使用してクライアントソース IP アドレスを保持するかどうかを指定します。有効な値： true：クライアントソース IP アドレスを保持します。 false (デフォルト)：クライアントソース IP アドレスを保持しません。説明このパラメーターは、TCP リスナーのエンドポイントグループに対してのみ設定できます。 `EnableClientIPPreservation` と `EnableProxyProtocol` の両方を `true` に設定することはできません。詳細については、「クライアントソース IP アドレスの保持」をご参照ください。	false
Endpoint	string	必須	`Type` パラメーターの値に基づいて、IP アドレス、ドメイン名、またはインスタンス ID を入力します。	120.XX.XX.21
SubAddress	string	任意	ENI (Elastic Network Interface) のプライベート 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****
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	任意	ポートオーバーライド設定のリスナーポート。説明 TCP リスナーの場合、仮想エンドポイントグループはポートオーバーライドをサポートしていません。リスナーがすでに仮想エンドポイントグループに関連付けられている場合、デフォルトのエンドポイントグループのポートオーバーライドを設定することはできません。デフォルトのエンドポイントグループにポートオーバーライドが設定されている場合、仮想エンドポイントグループを追加することはできません。ポートオーバーライドを設定した後、リスナープロトコルは HTTP と HTTPS の間でのみ変更できます。更新されたリスナーポート範囲には、設定されたポートオーバーライドのすべてのリスナーポートが含まれている必要があります。たとえば、リスナーポート範囲が 80-82 で、ポートオーバーライドがポートをエンドポイントポート 100-102 にマップするように設定されている場合、リスナーポート範囲を 80-81 に更新することはできません。	443
EndpointPort	integer	任意	ポートオーバーライド設定のエンドポイントポート。	80
HealthCheckEnabled	boolean	任意	ヘルスチェックを有効にするかどうかを指定します。有効な値： true：ヘルスチェックを有効にします。 false (デフォルト)：ヘルスチェックを無効にします。	true
HealthCheckHost	string	任意	ヘルスチェックのドメイン名。	www.taobao.com
EndpointIpVersion	string	任意	Global Accelerator がエンドポイントとの通信に使用する IP プロトコルを指定します。有効な値：● IPv4 (デフォルト)：IPv4 を使用します。● IPv6：IPv6 を使用します。● ProtocolAffinity：クライアントリクエストと同じ IP プロトコルを使用します。	IPv4

レスポンスフィールド

フィールド	型	説明	例
	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

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

変更履歴

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