1つ以上のエンドポイントグループを作成します。

説明

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

デバッグ

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

リクエストパラメーター

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

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

RegionId String 必須 cn-hangzhou

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

ClientToken String 任意 1F4B6A4A-C89E-489E-BAF1-52777EE148EF

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

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

説明 このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
DryRun Boolean いいえ 真実

リクエストのみを事前チェックするかどうかを指定します。 デフォルト値：false 有効な値：

  • true: 操作を実行せずにリクエストを事前チェックします。 システムは、必要なパラメーター、要求構文、および制限をチェックします。 リクエストが事前チェックに失敗した場合、エラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。
  • false: リクエストを送信します。 リクエストが事前チェックに合格すると、2xx HTTPステータスコードが返され、操作が実行されます。
AcceleratorId String 必須 ga-bp1odcab8tmno0hdq****

GA インスタンスの ID です。

ListenerId String 必須 lsr-bp1bpn0kn908w4nbw****

リスナーの ID を示します。

説明 リスナーのプロトコルがHTTPまたはHTTPSの場合、CreateEndpointGroups操作を呼び出した後に作成されるエンドポイントグループは1つだけです。
N.EndpointGroupName String 任意 group1

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

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

最大10個のエンドポイントグループの名前を入力できます。

N.EndpointGroupDescription EndpointGroupDescription String 任意 group1

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

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

最大10個のエンドポイントグループの説明を入力できます。

N.EndpointGroupRegion. EndpointGroupRegion String 必須 cn-hangzhou

エンドポイントグループを作成するリージョンのID。

最大10のリージョンのIDを入力できます。

N.TrafficPercentage EndpointGroupConfigurations. Long いいえ 20

トラフィック分配率の値。 リスナーが複数のエンドポイントグループに関連付けられている場合、このパラメーターを設定して、異なるトラフィックの割合をエンドポイントグループに分配できます。

有効な値: 1〜100。 デフォルト値: 100

最大10個のエンドポイントグループのトラフィック分散率を指定できます。

EndpointGroupConfigurations.N.HealthCheckEnabled Boolean いいえ false

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

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

最大10個のエンドポイントグループに対してヘルスチェック機能を有効にできます。

N.HealthCheckIntervalSeconds Long いいえ 3

ヘルスチェックが実行される間隔。 単位：秒。

ヘルスチェック間隔は最大10回まで指定できます。

EndpointGroupConfigurations.N.HealthCheckPath String 任意 /healthcheck

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

ヘルスチェックパスは最大10個まで指定できます。

N.HealthCheckPort EndpointGroupConfigurations. Long いいえ 20

ヘルスチェックに使用されるポート。 Valid values: 1 to 65535.

ヘルスチェックには最大10個のポートを指定できます。

N.HealthCheckProtocol EndpointGroupConfigurations String 任意 tcp

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

  • tcp: TCP
  • http: HTTP
  • https: HTTPS

最大10個のヘルスチェックプロトコルを指定できます。

N.ThresholdCount EndpointGroupConfigurations. Long いいえ 3

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

有効な値: 2〜10。 デフォルト値: 3

最大10個のエンドポイントグループに対して、連続したヘルスチェックの成功または失敗の数を指定できます。

N.EndpointConfigurations.N. タイプ 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) バケット

エンドポイントグループには、最大100種類のエンドポイントを指定できます。

説明
  • このパラメーターは必須です。
  • このパラメーターをECSまたはSLBに設定し、サービスにリンクされたロールAliyunServiceRoleForGaVpcEndpointが存在しない場合、システムはサービスにリンクされたロールを作成します。
  • このパラメーターをALBに設定し、サービスにリンクされたロールAliyunServiceRoleForGaAlbが存在しない場合、システムはサービスにリンクされたロールを作成します。
  • このパラメーターをOSSに設定し、サービスにリンクされたロールAliyunServiceRoleForGaOssが存在しない場合、システムはサービスにリンクされたロールを作成します。

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

N.EndpointConfigurations.N.Weight Long いいえ 20

エンドポイントの重み。

有効な値: 0〜255。

エンドポイントグループ内の最大100個のエンドポイントの重みを設定できます。

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

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

エンドポイントグループには、最大100個のエンドポイントIPアドレスまたはドメイン名を指定することができます。

説明 このパラメーターは必須です。
N.EndpointRequestProtocol. EndpointGroupConfigurations. String 任意 HTTP

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

  • HTTP: HTTP
  • HTTPS: HTTPS

最大10個のバックエンドサービスプロトコルを指定できます。

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

エンドポイントグループのタイプ。 デフォルト値：default。 有効な値：

  • default: デフォルトのエンドポイントグループ。
  • virtual: 仮想エンドポイントグループ。

最大10個のエンドポイントグループのタイプを指定できます。

説明 HTTPとHTTPSのリスナーのみが仮想エンドポイントグループをサポートします。
EndpointGroupConfigurations.N.PortOverrides.N.ListenerPort Long いいえ 443

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

最大5つのポートマッピングでリスナーポートを指定できます。

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

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

最大5つのポートマッピングでエンドポイントポートを指定できます。

EndpointGroupConfigurations.N.EnableClientIPPreservationToa Boolean いいえ false

TCPオプションアドレス (TOA) モジュールを使用してクライアントIPアドレスを保持するかどうかを指定します。 デフォルト値：false 有効な値：

  • true: TOAモジュールを使用してクライアントIPアドレスを保持します。
  • false: TOAモジュールを使用してクライアントのIPアドレスを保持しません。

このパラメーターは、最大10個のエンドポイントグループに対して指定できます。

N.EnableClientIPPreservationProxyProtocol EndpointGroupConfigurations. Boolean いいえ false

プロキシプロトコルを使用してクライアントIPアドレスを保持するかどうかを指定します。 デフォルト値：false 有効な値：

  • true: クライアントのIPアドレスを保持するためにプロキシプロトコルを使用します。
  • false: クライアントのIPアドレスを保持するためにプロキシプロトコルを使用しません。

このパラメーターは、最大10個のエンドポイントグループに対して指定できます。

レスポンスパラメーター

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

リクエストの ID です。

EndpointGroupIds 文字列の配列 epg-bp1dmlohjjz4kqaun****

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

例

リクエストの例

http(s)://[Endpoint]/?Action=CreateEndpointGroups
&RegionId=cn-hangzhou
&ClientToken=1F4B6A4A-C89E-489E-BAF1-52777EE148EF
&ドライラン=true
&AcceleratorId=ga-bp1odcab8tmno0hdq ****
&ListenerId=lsr-bp1bpn0kn908w4nbw ****
&EndpointGroupConfigurations=[{"EndpointGroupName":"group1","EndpointGroupDescription":"group1","EndpointGroupRegion":"cn-hangzhou","TrafficPercentage":"HealthCheckEnabled" "、" HealthCheckIntervalSecurds "、":"Health"" "" "" "" "、" 、"カウント"? "?" Thal? "?"? "?" ThPath "、" EndpointConfigurations ":[{" Type ":" Ip "、" Weight ":20、" Endpoint ":" 47.0.XX.XX "}] 、" EndpointRequestProtocol ":" HTTP "、" EndpointGroupType ":" default "、" PortOverrides ":[{" ListenerPort ":443、" EndpointPort "Presor":80 "Proxiap") ";" プロトコル: ";" Enxyipelp; "プロトコル:" Enxyal; "false}]
&<共通リクエストパラメーター>

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

XML 形式 

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

<CreateEndpointGroupsResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>
    <EndpointGroupIds>epg-bp1dmlohjjz4kqaun ****</EndpointGroupIds>
</CreateEndpointGroupsResponse>

JSON 形式 

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

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

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 ドメイン. NotFit ドメインがルールに適合しない ドメイン名にICP番号がない場合に返されるエラーメッセージ。
400 EndpointGroupExclusive.Listener すべてのエンドポイントグループは同じリスナーの下になければなりません。 すべてのエンドポイントグループが同じリスナーに関連付けられている必要がある場合に返されるエラーメッセージ。
400 RegionConflict.EndpointGroup 同じリスナーのエンドポイントグループには異なるリージョンが必要です。 同じリスナーに関連付けられているエンドポイントグループを異なるリージョンに展開する必要がある場合に返されるエラーメッセージ。
400 QuotaExceeded.EndpointGroup エンドポイントグループの数が制限を超えています。 エンドポイントグループの数が上限に達した場合に返されるエラーメッセージ。
400 NotExist.Listener リスナーが存在しません。 指定されたリスナーが存在しない場合に返されるエラーメッセージ。
400 NotActive.Listener リスナーの状態がアクティブではありません。 指定されたリスナーが不安定な場合に返されるエラーメッセージ。
400 NotExist.Accelerator 高速化されたインスタンスは存在しません。 指定されたGAインスタンスが存在しない場合に返されるエラーメッセージ。
400 NotExist.BusinessRegion ビジネスリージョンは存在しません。 指定されたリージョンが存在しない場合に返されるエラーメッセージ。
400 NotExist.BasicBandwidthPackage 基本帯域幅パッケージを指定する必要があります。 基本帯域幅プランが指定されていない場合に返されるエラーメッセージ。
400 QuotaExceeded.EndPoint エンドポイントの最大数を超えています。 エンドポイントの数が上限に達した場合に返されるエラーメッセージ。
400 NoPermission.VpcEndpoint 操作を実行する権限がありません。 サービスにリンクされたロールを作成する権限がない場合に返されるエラーメッセージ。 Alibaba Cloudアカウントの所有者または管理者に連絡して、AliyunGlobalAccelerationFullAccessポリシー、または必要なサービスにリンクされたロールを作成するための権限をRAMユーザーに付与するカスタム権限ポリシーをアタッチしてください。 カスタムポリシーでは、サービス名をo vpcendpoint.ga.aliyuncs.comに、サービスにリンクされたロールをAliyunServiceRoleForGaVpcEndpointに、権限をram:CreateServiceLinkedRoleに設定する必要があります。
400 QuotaExceeded.PortOverride ポートオーバーライドの数が制限を超えています。 ポートマッピングの数が上限に達した場合に返されるエラーメッセージ。

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