この API を呼び出して、Global Accelerator インスタンスに関連付けられているエンドポイントグループを照会できます。

デバッグ

OpenAPI Explorer はシグネチャの値を自動的に計算します。 この API は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer を使用すると、さまざまな SDK 向けにサンプルコードを動的に生成することができます。

リクエストパラメーター

パラメーター データ型 必須 / 任意 説明
Action String 必須 ListEndpointGroups

実行する API (ListEndpointGroups)を設定します。

AcceleratorId String 必須 ga-bp1odcab8tmno0hdq****

照会するエンドポイントグループが関連付けられているグローバルアクセラレータインスタンスの ID を設定します。

PageNumber Integer 必須 1

返されるページ数です。 ページは 1 ページ目から始まります。 デフォルト値は 1 です。

RegionId String 必須 cn-hangzhou

Global Accelerator インスタンスのリージョン ID を設定します。 値を cn-hangzhou に設定します。

PageSize Integer 任意 10

返される各ページのエントリ数を設定します。 設定可能な値は、1 から 100 です。 デフォルト値は 10 です。

ListenerId String 任意 lsr-bp1bpn0kn908w4nbw****

照会するエンドポイントグループに関連付けられたリスナーの ID を設定します。

レスポンスパラメーター

Parameter データ型 説明
RequestId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

リクエストの ID を示します。

TotalCount Integer 10

返されたエントリの総数を示します。

PageNumber Integer 1

返されたページの数を示します。

PageSize Integer 10

返されるエントリの 1 ページあたりの数を示します。

EndpointGroups Array

照会されたエンドポイントグループの設定を示します。

EndpointGroupId String epg-bp1dmlohjjz4kqaun****

エンドポイントグループの ID を示します。

Name String group1

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

説明 文字列 group1

セキュリティグループの説明です。

TrafficPercentage Integer 20

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

EndpointGroupRegion String cn-hangzhou

セキュリティグループのリージョン ID を示します。

State String active

エンドポイントグループのステータスを示します。 想定される値は以下のとおりです。

  • init :初期化中
  • active : 正常
  • creating:作成中
  • configuring :構成中
ListenerId String lsr-bp1bpn0kn908w4nbw ****

エンドポイントグループに関連付けられているリスナーの ID を示します。

HealthCheckIntervalSeconds Integer 3

連続した 2 回のヘルスチェックの時間間隔を設定します。 単位は秒です。

HealthCheckPath String /healthcheck

ヘルスチェック対象で確認先として設定されたパスを示します。

HealthCheckPort Integer 10

ヘルスチェック対象との接続に使用されるポートを示します。

HealthCheckProtocol String tcp

ヘルスチェック対象との接続に使用されるプロトコルを示します。

  • tcp:TCPプロトコル
  • http:HTTP プロトコル
  • https:HTTPS プロトコル
ThresholdCount Integer 3

エンドポイントの異常を宣言するまでに連続して失敗したヘルスチェックの回数を示します。

EndpointConfigurations Array

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

Endpoint String 12.xx.xx.78

クラウドサービスの IP アドレスまたはドメイン名を示します。

重み Integer 20

エンドポイントの重みを示します。

Type String IP

エンドポイントのタイプを示します。 想定される値は以下のとおりです。

  • Domain:カスタムドメイン名
  • Ip:カスタムIPアドレス

コーディング例

リクエストの例

http(s)://[Endpoint]/? Action=ListEndpointGroups
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&PageNumber=1
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式

<ListEndpointGroupsResponse>
  <PageNumber>1</PageNumber>
  <TotalCount>1</TotalCount>
  <EndpointGroups>
        <Name>dede</Name>
        <State>init</State>
        <EndpointGroupId>epg-bp1ple63864a5hyj5****</EndpointGroupId>
        <EndpointGroupRegion>cn-qingdao</EndpointGroupRegion>
        <EndpointConfigurations>
              <Weight>100</Weight>
              <Type>Ip</Type>
              <Endpoint>47.xx.xx.221</Endpoint>
        </EndpointConfigurations>
        <ThresholdCount>3</ThresholdCount>
        <ListenerId>lsr-bp12tl35dpsilnsb1****</ListenerId>
  </EndpointGroups>
  <PageSize>10</PageSize>
  <RequestId>2E35EDF9-7B39-4321-A644-7CEEC201F2EE</RequestId>
</ListEndpointGroupsResponse>

JSON 形式

{
  "PageNumber": 1,
  "TotalCount": 1,
  "EndpointGroups": [
    {
      "Name": "dede",
      "State": "init",
      "EndpointGroupId": "epg-bp1ple63864a5hyj5****",
      "EndpointGroupRegion": "cn-qingdao",
      "EndpointConfigurations": [
        {
          "Weight": 100,
          "Type": "Ip",
          "Endpoint": "47.xx.xx.221"
        }
      ],
      "ThresholdCount": 3,
      "ListenerId": "lsr-bp12tl35dpsilnsb1****"
    }
  ],
  "PageSize": 10,
  "RequestId": "2E35EDF9-7B39-4321-A644-7CEEC201F2EE"
}

エラーコード

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