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

説明　

  • UpdateEndpointGroupは非同期操作です。 リクエストを送信した後、システムはリクエストIDを返しますが、操作はシステムバックグラウンドで実行中です。 DescribeEndpointGroup操作を呼び出して、エンドポイントグループの状態を照会できます。
    • エンドポイントグループが更新中の場合は、エンドポイントグループの設定が変更されていることを示します。 この場合、クエリ操作のみを実行できます。
    • エンドポイントグループがアクティブ状態の場合、エンドポイントグループの設定が変更されていることを示します。
  • UpdateEndpointGroup操作は、特定の期間内に同じGlobal Accelerator (GA) インスタンスに対して繰り返し呼び出すことはできません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 UpdateEndpointGroup

実行する操作です。 値をUpdateEndpointGroupに設定します。

RegionId String 必須 cn-hangzhou

GAインスタンスがデプロイされているリージョンのID。 値をcn-hangzhouに設定します。

ClientToken String 任意 123e4567-e89b-12d3-a456-426655440000

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

クライアントを使用して値を生成できますが、すべてのリクエスト間で一意であることを確認する必要があります。 ClientTokenにはASCII文字のみを含めることができます。

説明 このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
EndpointGroupId String 必須 epg-bp1dmlohjjz4kqaun****

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

名前 String 任意 group1

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

名前は2 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。 先頭は英字とする必要があります。

説明　 String 任意 EndpointGroup

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

説明の長さは256文字を超えることはできません。また、http:// またはhttps:// は使用できません。

EndpointGroupRegion String 必須 cn-hangzhou

エンドポイントグループが作成されたリージョンのID。

TrafficPercentage Integer いいえ 20

リスナーが複数のエンドポイントグループに関連付けられている場合のエンドポイントグループの重み。

HealthCheckIntervalSeconds Integer いいえ 3

連続した 2 回のヘルスチェックの時間間隔を設定します 単位：秒。 有効な値: 1〜50。

HealthCheckPath String 任意 /healthcheck

ヘルスチェックリクエストが送信されるパス。

HealthCheckPort Integer いいえ 20

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

HealthCheckProtocol String 任意 tcp

ヘルスチェック要求が送信されるプロトコル。 有効な値：

  • tcp: TCP
  • http: HTTP
  • https: HTTPS
ThresholdCount Integer いいえ 3

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

有効な値: 2〜10。

EndpointConfigurations.N.Type String 必須 Ip

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

  • ドメイン: カスタムドメイン名
  • Ip: カスタムIPアドレス
  • PublicIp: Alibaba Cloudが提供するパブリックIPアドレス
  • ECS: Elastic Compute Service (ECS) インスタンス
  • SLB: Server Load Balancer (SLB) インスタンス
  • ALB: Application Load Balancer (ALB) インスタンス
  • OSS: Object Storage Service (OSS) バケット
説明
  • このパラメーターをECSまたはSLBに設定し、サービスにリンクされたロールAliyunServiceRoleForGaVpcEndpointが存在しない場合、システムはサービスにリンクされたロールを自動的に作成します。
  • このパラメーターをALBに設定し、サービスにリンクされたロールAliyunServiceRoleForGaAlbが存在しない場合、システムはサービスにリンクされたロールを自動的に作成します。
  • このパラメーターをOSSに設定し、サービスにリンクされたロールAliyunServiceRoleForGaOssが存在しない場合、システムはサービスにリンクされたロールを自動的に作成します。

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

N.EnableClientIPPreservation Boolean いいえ false

クライアントIPアドレスを予約するかどうかを指定します。 デフォルト値：false 有効な値：

  • true: クライアントIPアドレスを予約します。
  • false: クライアントIPアドレスを予約しません。
EndpointConfigurations.N.Weight Integer 〇 20

エンドポイントの重み。

有効な値: 0〜255。

説明 エンドポイントの重みが0に設定されている場合、GAはエンドポイントへのネットワークトラフィックの配信を停止します。 操作は慎重に行ってください。
EndpointConfigurations.N.Endpoint String 必須 120.XX.XX.21

エンドポイントの IP アドレスまたはドメイン名。

EndpointRequestProtocol String 任意 HTTP

バックエンドサービスによって使用されるプロトコル。 有効な値：

  • HTTP
  • HTTPS
説明
  • このパラメーターは、エンドポイントグループに関連付けられているリスナーがHTTPまたはHTTPSプロトコルを使用している場合にのみ設定できます。
  • HTTPリスナーの場合、バックエンドサービスプロトコルはHTTPである必要があります。
PortOverrides.N.ListenerPort Integer いいえ 443

エンドポイントポートにマップされているリスナーポート。

説明
  • HTTPおよびHTTPSリスナーのみがポートマッピングをサポートしています。
  • ポートマッピングのリスナーポートは、現在のリスナーで使用されているポートである必要があります。
PortOverrides.N.EndpointPort Integer いいえ 80

リスナーポートにマップされているエンドポイントポート。

HealthCheckEnabled Boolean いいえ 真実

ヘルスチェック機能を有効にするかどうかを示します。 デフォルト値：true 有効な値：

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

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

リクエストの ID です。

例

リクエストの例

http(s)://[Endpoint]/?Action=UpdateEndpointGroup
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&EndpointGroupId=epg-bp1dmlohjjz4kqaun ****
&名前=group1
&Description=EndpointGroup
&EndpointGroupRegion=cn-hangzhou
&TrafficPercentage=20
&HealthCheckIntervalSeconds=3
&HealthCheckPath=/healthcheck
&HealthCheckPort=20
&HealthCheckProtocol=tcp
&ThresholdCount=3
&EndpointConfigurations=[{"Type":"Ip","EnableClientIPPreservation":false,"Weight":20,"Endpoint":"120.XX. XX.21"}]
&EndpointRequestProtocol=HTTP
&PortOverrides=[{"ListenerPort":443,"EndpointPort":80}]
&HealthCheckEnabled=true
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateEndpointGroupResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8 </RequestId>
</UpdateEndpointGroupResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

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

エラーコード

HttpCode エラーコード エラーメッセージ 説明　
400 NotExist.EndPointGroup エンドポイントグループが存在しません。 指定されたエンドポイントグループが存在しない場合に返されるエラーメッセージ。
400 StateError.EndPointGroup エンドポイントグループの指定された状態は無効です。 指定されたエンドポイントグループの状態が無効な場合に返されるエラーメッセージ。
400 NotExist.Listener リスナーが存在しません。 指定されたリスナーが存在しない場合に返されるエラーメッセージ。
400 NotActive.Listener リスナーの状態がアクティブではありません。 指定されたリスナーが不安定な場合に返されるエラーメッセージ。
400 NotExist.Accelerator 高速化されたインスタンスは存在しません。 GAインスタンスが存在しない場合に返されるエラーメッセージ。
400 QuotaExceeded.EndPoint エンドポイントの最大数を超えています。 エンドポイントの数が上限に達した場合に返されるエラーメッセージ。
400 NoPermission.VpcEndpoint 操作を実行する権限がありません。 サービスにリンクされたロールを作成する権限がない場合に返されるエラーメッセージ。 Alibaba Cloudアカウントの所有者または管理者に連絡して、AliyunGlobalAccelerationFullAccessポリシー、または必要なサービスにリンクされたロールを作成するための権限をRAMユーザーに付与するカスタム権限ポリシーをアタッチしてください。 カスタムポリシーでは、サービス名をo vpcendpoint.ga.aliyuncs.comに、サービスにリンクされたロールをAliyunServiceRoleForGaVpcEndpointに、権限をram:CreateServiceLinkedRoleに設定する必要があります。
400 QuotaExceeded.PortOverride ポートオーバーライドの数が制限を超えています。 ポートマッピングの数が上限に達した場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。