この操作では、エンドポイントグループに関する情報を照会します。

デバッグ

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

リクエストパラメーター

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

実行する API 。 この値を DescribeEndpointGroup に設定します。

EndpointGroupId String 必須 epg-bp1dmlohjjz4kqaun****

エンドポイントグループの ID。
RegionId String 必須 cn-hangzhou

指定されたエンドポイントグループが関連付けられている Global Accelerator インスタンスのリージョン ID。 この値を cn-hangzhou に設定します。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

リクエストの ID 。
TotalCount Integer 10

返されたエントリの総数。
EndpointGroupId String epg-bp1dmlohjjz4kqaun****

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

エンドポイントグループの名前。
Description String 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 20

ヘルスチェックの対象との接続に使用されるポート。
HealthCheckProtocol String tcp

ヘルスチェックの対象との接続に使用されるプロトコル。 有効値：

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

連続して失敗するとエンドポイントの異常宣言がされるヘルスチェックの回数。
EndpointConfigurations Array

指定されたエンドポイントグループ内のエンドポイントの設定。
Endpoint String 120.xx.xx.21

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

エンドポイントの重み。
Type String IP

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

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

コーディング例

リクエスト例

http(s)://[Endpoint]/? Action=DescribeEndpointGroup
&EndpointGroupId=epg-bp1dmlohjjz4kqaun****
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式 

<DescribeEndpointGroupResponse>
      <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>
      <Name>dede</Name>
      <State>init</State>
      <RequestId>A3E6CB31-DA8A-4437-8B0B-E36546AE9E79</RequestId>
      <ListenerId>lsr-bp12tl35dpsilnsb1****</ListenerId>
</DescribeEndpointGroupResponse>

JSON 形式 

{
  "EndpointGroupId": "epg-bp1ple63864a5hyj5****",
  "EndpointGroupRegion": "cn-qingdao",
  "EndpointConfigurations": [
    {
      "Weight": 100,
      "Type": "Ip",
      "Endpoint": "47.xx.xx.221"
    }
  ],
  "ThresholdCount": 3,
  "Name": "dede",
  "State": "init",
  "RequestId": "A3E6CB31-DA8A-4437-8B0B-E36546AE9E79",
  "ListenerId": "lsr-bp12tl35dpsilnsb1****"
}

エラーコード

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