すべてのプロダクト
Search

このプロダクト

    :DescribeEndpointGroup

    ドキュメントセンター

    :DescribeEndpointGroup

    最終更新日:Dec 14, 2025

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

    今すぐお試しください

    この 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 (GA) インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。

    cn-hangzhou
    EndpointGroupId

    string

    必須

    照会するエンドポイントグループの ID。

    epg-bp14sz7ftcwwjgrdm****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    HealthCheckIntervalSeconds

    integer

    ヘルスチェックの間隔 (秒)。

    3
    TrafficPercentage

    integer

    エンドポイントグループにルーティングされるトラフィックの割合。

    20
    EndpointGroupId

    string

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

    epg-bp14sz7ftcwwjgrdm****
    Description

    string

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

    group1
    EndpointGroupIpList

    array

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

    string

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

    101.XX.XX.22
    EndpointGroupUnconfirmedIpList

    array

    GA インスタンスのスペックアップ後、確認待ちのエンドポイントの IP アドレス。

    string

    確認待ちのエンドポイントの 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

    • http または HTTP

    • https または HTTPS

    tcp
    HealthCheckPort

    integer

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

    20
    EndpointConfigurations

    array<object>

    エンドポイントの構成。

    object

    エンドポイントの構成。

    Type

    string

    エンドポイントのタイプ。

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

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

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

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

    • ECS：Elastic Compute Service (ECS) インスタンス。

    • SLB：Server Load Balancer (SLB) インスタンス。

    • ALB：Application Load Balancer (ALB) インスタンス。

    • OSS：Object Storage Service (OSS) バケット。

    • ENI：Elastic Network Interface (ENI)。

    • NLB：Network Load Balancer (NLB) インスタンス。

    Ip
    EnableClientIPPreservation

    boolean

    クライアント IP アドレスを保持するかどうかを指定します。

    • true：クライアント IP アドレスは保持されます。

    • false：クライアント IP アドレスは保持されません。

    false
    Weight

    integer

    エンドポイントの重み。

    20
    ProbeProtocol

    string

    遅延検出プロトコル。

    • tcp

    • icmp

    tcp
    Endpoint

    string

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

    120.XX.XX.21
    EnableProxyProtocol

    boolean

    クライアント IP アドレスを保持するためにプロキシプロトコルを使用するかどうかを指定します。

    • true：プロキシプロトコルが使用されます。

    • false：プロキシプロトコルは使用されません。

    false
    ProbePort

    integer

    遅延検出ポート。

    80
    SubAddress

    string

    ENI のプライベート IP アドレス。

    172.168.XX.XX
    VpcId

    string

    エンドポイントがデプロイされている virtual private cloud (VPC) の ID。

    vpc-hp30gtnxkfxj1l2xt****
    VSwitchIds

    array

    vSwitch ID のリスト。

    string

    vSwitch の ID。

    vsw-bp1nx4sxxe1nnr1ja****
    PortOverrides

    array<object>

    ポートマッピング。

    object

    ポートマッピング。

    ListenerPort

    integer

    リスナーポート。

    443
    EndpointPort

    integer

    エンドポイントポート。

    80
    EndpointRequestProtocol

    string

    バックエンドサービスプロトコル。

    • HTTP

    • HTTPS

    HTTP
    EndpointProtocolVersion

    string

    バックエンドサービスプロトコルのバージョン。

    • HTTP1.1

    • HTTP2

    EndpointGroupType

    string

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

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

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

    default
    ForwardingRuleIds

    array

    関連付けられた転送ルールの ID のリスト。

    string

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

    frule-bp19a3t3yzr21q3****
    AcceleratorId

    string

    GA インスタンスの ID。

    ga-bp1odcab8tmno0hdq****
    ListenerId

    string

    リスナーの ID。

    lsr-bp1bpn0kn908w4nbw****
    SlsRegion

    string

    Simple Log Service (SLS) プロジェクトのリージョン。

    cn-hangzhou
    SlsProjectName

    string

    SLS プロジェクトの名前。

    pn-01
    SlsLogStoreName

    string

    SLS 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

    インスタンスが別の Alibaba Cloud サービスによって管理されているかどうかを指定します。

    • 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

    例

    成功レスポンス

    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****"
      ]
    }
  ],
  "PortOverrides": [
    {
      "ListenerPort": 443,
      "EndpointPort": 80
    }
  ],
  "EndpointRequestProtocol": "HTTP",
  "EndpointProtocolVersion": "",
  "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": ""
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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