すべてのプロダクト
Search

このプロダクト

    :DescribeEndpointGroup

    ドキュメントセンター

    :DescribeEndpointGroup

    最終更新日:May 06, 2026

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

    今すぐお試しください

    この 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:DescribeEndpointGroup

    get

    *EndpointGroup

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

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

    cn-hangzhou
    EndpointGroupId

    string

    必須

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

    epg-bp14sz7ftcwwjgrdm****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーターです。

    HealthCheckIntervalSeconds

    integer

    ヘルスチェックの間隔（秒単位）です。

    3
    TrafficPercentage

    integer

    エンドポイントグループに分散されるトラフィックの割合です。このパラメーターは、リスナーが複数のエンドポイントグループに関連付けられている場合にのみ返されます。

    100
    EndpointGroupId

    string

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

    epg-bp14sz7ftcwwjgrdm****
    Description

    string

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

    group1
    EndpointGroupIpList

    array

    エンドポイントグループ内のエンドポイントのアクティブな IP アドレスのリストです。

    重要 プライベートネットワークからのソース復帰用に構成されたエンドポイントグループの場合、コンソールにはパブリック IP アドレスではなく、プライベートソース復帰 IP アドレスのみが表示されます。エンドポイントグループのバックエンドサービスのネットワーク接続タイプが変更された場合（例：プライベートネットワークからパブリックネットワークへ、またはプライベートとパブリックネットワークの混合へ）、ソース復帰 IP アドレスの変更を監視し、バックエンドサービスのアクセス制御リスト（ACL）を適宜更新する必要があります。

    string

    アクティブなエンドポイントの IP アドレスです。

    101.XX.XX.22
    EndpointGroupUnconfirmedIpList

    array

    Global Accelerator インスタンスのスペックアップ後に確認待ちとなっているエンドポイント IP アドレスのリストです。

    string

    Global Accelerator インスタンスのスペックアップ後に確認待ちとなっているエンドポイントの IP アドレスです。

    101.XX.XX.22
    RequestId

    string

    リクエスト ID です。

    6FEA0CF3-D3B9-43E5-A304-D217037876A8

    HealthCheckPath

    string

    ヘルスチェックプローブのパスです。

    /healthcheck
    ThresholdCount

    integer

    エンドポイントが異常とマークされる前に連続してヘルスチェックが失敗する回数です。

    3
    Name

    string

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

    group1
    EndpointGroupRegion

    string

    エンドポイントグループがデプロイされているリージョン ID です。

    cn-hangzhou
    State

    string

    エンドポイントグループのステータスです。

    • init：エンドポイントグループが初期化中です。

    • active：エンドポイントグループがアクティブです。

    • updating：エンドポイントグループが更新中です。

    • deleting：エンドポイントグループが削除中です。

    active
    HealthCheckProtocol

    string

    ヘルスチェックに使用されるプロトコルです。

    • tcp または TCP：TCP

    • http または HTTP：HTTP

    • https または HTTPS：HTTPS

    tcp
    HealthCheckPort

    integer

    ヘルスチェックに使用されるポートです。

    20
    EndpointConfigurations

    array<object>

    エンドポイントの構成です。

    object

    エンドポイントの構成です。

    Type

    string

    エンドポイントのタイプです。有効な値は次のとおりです。

    • Domain：カスタムドメイン名

    • Ip：カスタム IP アドレス

    • IpTarget：カスタムプライベート IP アドレス

    • PublicIp：Alibaba Cloud パブリック IP アドレス

    • ECS：ECS インスタンス

    • SLB：SLB インスタンス

    • ALB：ALB インスタンス

    • OSS：OSS インスタンス

    • ENI：エラスティックネットワークインターフェース

    • NLB：NLB インスタンス

    Ip
    EnableClientIPPreservation

    boolean

    自動方式によるクライアント IP 保存が有効かどうかを示します。

    • true：有効

    • false：無効

    false
    Weight

    integer

    エンドポイントの重みです。

    255
    ProbeProtocol

    string

    レイテンシープロービングに使用されるプロトコルです。有効な値は次のとおりです。

    • tcp：TCP

    • icmp：ICMP

    tcp
    Endpoint

    string

    エンドポイントの IP アドレス、ドメイン名、またはインスタンス ID です。

    120.XX.XX.21
    EnableProxyProtocol

    boolean

    Proxy Protocol を使用したクライアント IP 保存が有効かどうかを示します。

    • true：有効

    • false：無効

    false
    ProbePort

    integer

    レイテンシープロービングに使用されるポートです。

    80
    SubAddress

    string

    エラスティックネットワークインターフェースのプライベート IP アドレスです。

    172.168.XX.XX
    VpcId

    string

    VPC ID です。

    vpc-hp30gtnxkfxj1l2xt****
    VSwitchIds

    array

    VSwitch ID のリストです。

    string

    VSwitch ID です。

    vsw-bp1nx4sxxe1nnr1ja****
    Provider

    string

    エンドポイント構成のプロバイダーです。

    BAILIAN
    ApiKeys

    array

    エンドポイント構成の API キーです。

    string

    エンドポイント構成内の API キーです。

    sk-*******
    PortOverrides

    array<object>

    ポートマッピングの構成です。

    object

    ポートマッピングの構成です。

    ListenerPort

    integer

    リスナーポートです。

    443
    EndpointPort

    integer

    エンドポイントポートです。

    80
    EndpointRequestProtocol

    string

    バックエンドサービスで使用されるプロトコルです。有効な値は次のとおりです。

    • HTTP

    • HTTPS

    HTTP
    EndpointProtocolVersion

    string

    バックエンドサービスプロトコルのバージョンです。有効な値は次のとおりです。

    • HTTP1.1

    • HTTP2

    HTTP2
    EndpointGroupType

    string

    エンドポイントグループのタイプです。有効な値は次のとおりです。

    • default：デフォルトエンドポイントグループ

    • virtual：仮想エンドポイントグループ

    default
    ForwardingRuleIds

    array

    関連付けられた転送ルールの ID です。

    string

    転送ルール ID です。

    frule-bp19a3t3yzr21q3****
    AcceleratorId

    string

    Global Accelerator インスタンス ID です。

    ga-bp1odcab8tmno0hdq****
    ListenerId

    string

    リスナー ID です。

    lsr-bp1bpn0kn908w4nbw****
    SlsRegion

    string

    Log Service プロジェクトのリージョンです。

    cn-hangzhou
    SlsProjectName

    string

    Log Service プロジェクトの名前です。

    pn-01
    SlsLogStoreName

    string

    Logstore の名前です。

    lsn-01
    AccessLogSwitch

    string

    アクセスログ構成のステータスです。有効な値は次のとおりです。

    • on：アクセスログが構成されています。

    • off：アクセスログが構成されていません。

    • binding：アクセスログが構成中です。

    • unbinding：アクセスログ構成が解除中です。

    on
    EnableAccessLog

    boolean

    アクセスログ記録が有効かどうかを示します。

    • true：アクセスログ記録が有効です。

    • false：アクセスログ記録が無効です。

    true
    HealthCheckEnabled

    boolean

    ヘルスチェックが有効かどうかを示します。

    • true：ヘルスチェックが有効です。

    • false：ヘルスチェックが無効です。

    true
    ServiceId

    string

    インスタンスを管理するサービスの ID です。

    説明

    このパラメーターは、ServiceManaged が True に設定されている場合にのみ返されます。

    ALB
    ServiceManaged

    boolean

    インスタンスがサービス管理インスタンスかどうかを示します。有効な値は次のとおりです。

    • true：インスタンスはサービス管理インスタンスです。

    • false：インスタンスはサービス管理インスタンスではありません。

    true
    ServiceManagedInfos

    array<object>

    インスタンスに対して実行可能な操作の管理状態のリストです。

    説明

    • このパラメーターは、ServiceManaged が True に設定されている場合にのみ返されます。

    • インスタンスが管理対象の場合、一部の操作が制限される可能性があります。

    object

    特定の操作の管理状態です。

    Action

    string

    ホストインスタンスに対する操作の名前です。有効な値は次のとおりです。

    • Create：インスタンスを作成

    • Update：インスタンスを更新

    • Delete：インスタンスを削除

    • Associate：インスタンスを関連付け

    • UserUnmanaged：インスタンスのサービス管理を解除

    • CreateChild：子リソースを作成

    Update
    ChildType

    string

    子リソースのタイプです。有効な値は次のとおりです。

    • Listener：リスナー

    • IpSet：加速リージョン

    • EndpointGroup：エンドポイントグループ

    • ForwardingRule：転送ルール

    • Endpoint：エンドポイント

    • EndpointGroupDestination：カスタムルーティングリスナーのエンドポイントグループのプロトコルマッピング

    • EndpointPolicy：カスタムルーティングリスナーのエンドポイントのトラフィックポリシー

    説明

    このパラメーターは、Action が CreateChild に設定されている場合にのみ有効です。

    Listener
    IsManaged

    boolean

    操作が管理されているかどうかを示します。有効な値は次のとおりです。

    • true：操作は管理されています。このインスタンスに対してこの操作を実行できません。

    • false：操作は管理されていません。このインスタンスに対してこの操作を実行できます。

    false
    Tags

    array<object>

    エンドポイントグループにアタッチされたタグのリストです。

    object

    タグです。

    Key

    string

    タグキーです。

    test-key
    Value

    string

    タグ値です。

    test-value
    HealthCheckHost

    string

    ヘルスチェックに使用されるドメイン名です。

    www.taobao.com
    AccessLogRecordCustomizedHeadersEnabled

    boolean

    アクセスログにカスタムヘッダーフィールドを記録するかどうかを指定します。有効な値は次のとおりです。

    • true：はい

    • false（デフォルト）：いいえ

    説明

    EnableAccessLog が true に設定されている場合にのみ、このパラメーターを true に設定できます。

    AccessLogRecordCustomizedHeaderList

    array

    アクセスログに記録するカスタムヘッダーフィールドです。

    string

    アクセスログに記録するカスタムヘッダーフィールドです。

    ['sda', 'dsaasdd', 'dsada']
    EndpointIpVersion

    string

    バックエンドサービスへの接続に使用される IP バージョンです。有効な値は次のとおりです。

    • IPv4（デフォルト）：Global Accelerator は IPv4 を使用してバックエンドサービスに接続します。

    • IPv6：Global Accelerator は IPv6 を使用してバックエンドサービスに接続します。

    • ProtocolAffinity：Global Accelerator はクライアントリクエストと同じ IP バージョンを使用してバックエンドサービスに接続します。

    IPv4
    EndpointPrivateIpList

    array<object>

    エンドポイントのプライベート IP アドレスです。

    object

    PrivateIp

    string

    プライベート IP アドレスです。

    172.16.49.***
    VSwitchId

    string

    VPC 内の VSwitch ID です。

    gsw-bp1rsfd2frym**
    CIDR

    string

    例

    成功レスポンス

    JSONJSON

    {
  "HealthCheckIntervalSeconds": 3,
  "TrafficPercentage": 100,
  "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
  "Description": "group1",
  "EndpointGroupIpList": [
    "101.XX.XX.22"
  ],
  "EndpointGroupUnconfirmedIpList": [
    "101.XX.XX.22"
  ],
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "HealthCheckPath": "/healthcheck",
  "ThresholdCount": 3,
  "Name": "group1",
  "EndpointGroupRegion": "cn-hangzhou",
  "State": "active",
  "HealthCheckProtocol": "tcp",
  "HealthCheckPort": 20,
  "EndpointConfigurations": [
    {
      "Type": "Ip",
      "EnableClientIPPreservation": false,
      "Weight": 255,
      "ProbeProtocol": "tcp",
      "Endpoint": "120.XX.XX.21",
      "EnableProxyProtocol": false,
      "ProbePort": 80,
      "SubAddress": "172.168.XX.XX",
      "VpcId": "vpc-hp30gtnxkfxj1l2xt****",
      "VSwitchIds": [
        "vsw-bp1nx4sxxe1nnr1ja****"
      ],
      "Provider": "BAILIAN",
      "ApiKeys": [
        "sk-*******"
      ]
    }
  ],
  "PortOverrides": [
    {
      "ListenerPort": 443,
      "EndpointPort": 80
    }
  ],
  "EndpointRequestProtocol": "HTTP",
  "EndpointProtocolVersion": "HTTP2",
  "EndpointGroupType": "default",
  "ForwardingRuleIds": [
    "frule-bp19a3t3yzr21q3****"
  ],
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "SlsRegion": "cn-hangzhou",
  "SlsProjectName": "pn-01",
  "SlsLogStoreName": "lsn-01",
  "AccessLogSwitch": "on",
  "EnableAccessLog": true,
  "HealthCheckEnabled": true,
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ],
  "Tags": [
    {
      "Key": "test-key",
      "Value": "test-value"
    }
  ],
  "HealthCheckHost": "www.taobao.com",
  "AccessLogRecordCustomizedHeadersEnabled": false,
  "AccessLogRecordCustomizedHeaderList": [
    "['sda', 'dsaasdd', 'dsada']"
  ],
  "EndpointIpVersion": "IPv4",
  "EndpointPrivateIpList": [
    {
      "PrivateIp": "172.16.49.***",
      "VSwitchId": "gsw-bp1rsfd2frym**",
      "CIDR": ""
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 UnknownError An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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

    変更履歴

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