すべてのプロダクト
Search

このプロダクト

    :ListEndpointGroups

    ドキュメントセンター

    :ListEndpointGroups

    最終更新日:Dec 31, 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:ListEndpointGroups

    list

    *EndpointGroup

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

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

    cn-hangzhou
    PageNumber

    integer

    任意

    ページ番号。デフォルト値：1。

    1
    PageSize

    integer

    任意

    ページあたりのエントリ数。最大値：50。デフォルト値：10。

    10
    AcceleratorId

    string

    必須

    GA インスタンスの ID。

    ga-bp1odcab8tmno0hdq****
    ListenerId

    string

    任意

    リスナーの ID。

    lsr-bp1bpn0kn908w4nbw****
    EndpointGroupType

    string

    任意

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

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

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

    • このパラメーターを空のままにすると、デフォルトと仮想の両方のエンドポイントグループが照会されます。

    virtual
    AccessLogSwitch

    string

    任意

    アクセスログ機能を有効にするかどうかを指定します。有効な値：

    • on：アクセスログ機能を有効にします。

    • off (デフォルト)：アクセスログ機能を無効にします。

    on
    EndpointGroupId

    string

    任意

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

    epg-bp16jdc00bhe97sr5****
    Tag

    array<object>

    任意

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

    object

    任意

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

    Key

    string

    任意

    エンドポイントグループのタグキー。タグキーは空の文字列にすることはできません。

    タグキーは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。

    最大 20 個のタグキーを指定できます。

    test-key
    Value

    string

    任意

    エンドポイントグループのタグ値。タグ値は空の文字列にすることができます。

    タグ値は最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。

    最大 20 個のタグ値を指定できます。

    test-value

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返される情報のリスト。

    TotalCount

    integer

    返されたエントリの総数。

    1
    PageSize

    integer

    ページあたりのエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    A052D49E-CCC2-41DB-816C-DC3381503194

    PageNumber

    integer

    ページ番号。

    1
    EndpointGroups

    array<object>

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

    array<object>

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

    EndpointGroupId

    string

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

    epg-bp16jdc00bhe97sr5****
    EndpointGroupIpList

    array

    エンドポイントグループのパブリック IP アドレスのリスト。

    string

    エンドポイントグループのパブリック IP アドレスのリスト。

    47.1.XX.XX
    EndpointGroupUnconfirmedIpList

    array

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

    string

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

    47.1.XX.XX
    State

    string

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

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

    • active：エンドポイントグループは実行中です。

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

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

    active
    HealthCheckPath

    string

    ヘルスチェックのパス。

    /healthcheck
    EndpointGroupRegion

    string

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

    cn-hangzhou
    HealthCheckIntervalSeconds

    integer

    2 回の連続したヘルスチェックの間隔。単位：秒。

    3
    TrafficPercentage

    integer

    トラフィック分散の比率。リスナーが複数のエンドポイントグループに関連付けられている場合、指定された比率に基づいてトラフィックがエンドポイントグループに分散されます。

    100
    HealthCheckProtocol

    string

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

    • tcp または TCP：TCP。

    • http または HTTP：HTTP。

    • https または HTTPS：HTTPS。

    tcp
    ThresholdCount

    integer

    エンドポイントが異常と見なされるまでに発生する必要がある、連続したヘルスチェックの失敗回数。

    3
    ListenerId

    string

    リスナーの ID。

    lsr-bp1bpn0kn908w4nbw****
    AcceleratorId

    string

    GA インスタンスの ID。

    ga-bp1odcab8tmno0hdq****
    EndpointConfigurations

    array<object>

    エンドポイントの設定。

    object

    エンドポイントの設定。

    Type

    string

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

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

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

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

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

    • ECS：Alibaba Cloud ECS インスタンス。

    • SLB：Alibaba Cloud SLB インスタンス。

    • ALB：Alibaba Cloud ALB インスタンス。

    • OSS：Alibaba Cloud OSS バケット。

    • ENI：Alibaba Cloud Elastic Network Interface (ENI)。

    • NLB：Alibaba Cloud NLB インスタンス。

    Ip
    EnableClientIPPreservation

    boolean

    クライアント IP の保持機能が有効になっているかどうかを示します。

    • true：クライアント IP の保持機能は有効です。

    • false：クライアント IP の保持機能は無効です。

    false
    Weight

    integer

    エンドポイントの重み。

    20
    ProbeProtocol

    string

    レイテンシのプローブに使用されるプロトコル。

    • icmp：ICMP。

    • tcp：TCP。

    tcp
    Endpoint

    string

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

    47.1.XX.XX
    EnableProxyProtocol

    boolean

    クライアント IP アドレスを保持するために Proxy Protocol が使用されるかどうかを示します。

    • true：クライアント IP アドレスを保持するために Proxy Protocol が使用されます。

    • false：クライアント IP アドレスを保持するために Proxy Protocol は使用されません。

    ProbePort

    integer

    レイテンシのプローブに使用されるポート。

    80
    EndpointId

    string

    エンドポイントの ID。

    ep-bp1d2utp8qqe2a44t****
    SubAddress

    string

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

    172.168.XX.XX
    VpcId

    string

    VPC の ID。

    vpc-8vbhucmd5b2q2fpqqu****
    VSwitchIds

    array

    VPC 内の vSwitch のリスト。

    string

    vSwitch の ID。

    vsw-hp3xwc2aebg2u30ln****
    PortOverrides

    array<object>

    ポートマッピング。

    object

    ポートマッピング。

    ListenerPort

    integer

    リスナーポート。

    443
    EndpointPort

    integer

    エンドポイントポート。

    80
    ForwardingRuleIds

    array

    エンドポイントグループに関連付けられている転送ルールの ID。

    string

    エンドポイントグループに関連付けられている転送ルールの ID。

    frule-bp19a3t3yzr21q3****
    EndpointGroupType

    string

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

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

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

    default
    EndpointRequestProtocol

    string

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

    • HTTP：HTTP。

    • HTTPS：HTTPS。

    HTTP
    EndpointProtocolVersion

    string

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

    • HTTP1.1：HTTP/1.1。

    • HTTP2：HTTP/2。

    HTTP1.1
    Description

    string

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

    group1
    Name

    string

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

    group1
    HealthCheckPort

    integer

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

    10
    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
    EndpointIpVersion

    string

    バックエンドサービスの IP プロトコル。有効な値：

    • IPv4 (デフォルト)：GA は IPv4 アドレスを使用してエンドポイントサービスと通信します。

    • IPv6：GA は IPv6 アドレスを使用してエンドポイントサービスと通信します。

    • ProtocolAffinity：GA がエンドポイントサービスとの通信に使用する IP プロトコルは、クライアントがリクエストの送信に使用する IP プロトコルと同じです。

    IPv4
    EndpointPrivateIpList

    array<object>

    バックエンドサービスのプライベート IP アドレスのリスト。

    object

    PrivateIp

    string

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

    172.19.115.37
    VSwitchId

    string

    VPC 内の vSwitch の ID。

    gsw-0jl6tmriqep1ga***
    CIDR

    string

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "A052D49E-CCC2-41DB-816C-DC3381503194\t",
  "PageNumber": 1,
  "EndpointGroups": [
    {
      "EndpointGroupId": "epg-bp16jdc00bhe97sr5****",
      "EndpointGroupIpList": [
        "47.1.XX.XX"
      ],
      "EndpointGroupUnconfirmedIpList": [
        "47.1.XX.XX"
      ],
      "State": "active",
      "HealthCheckPath": "/healthcheck",
      "EndpointGroupRegion": "cn-hangzhou",
      "HealthCheckIntervalSeconds": 3,
      "TrafficPercentage": 100,
      "HealthCheckProtocol": "tcp",
      "ThresholdCount": 3,
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "EndpointConfigurations": [
        {
          "Type": "Ip",
          "EnableClientIPPreservation": false,
          "Weight": 20,
          "ProbeProtocol": "tcp",
          "Endpoint": "47.1.XX.XX",
          "EnableProxyProtocol": false,
          "ProbePort": 80,
          "EndpointId": "ep-bp1d2utp8qqe2a44t****",
          "SubAddress": "172.168.XX.XX",
          "VpcId": "vpc-8vbhucmd5b2q2fpqqu****",
          "VSwitchIds": [
            "vsw-hp3xwc2aebg2u30ln****"
          ]
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "ForwardingRuleIds": [
        "frule-bp19a3t3yzr21q3****"
      ],
      "EndpointGroupType": "default",
      "EndpointRequestProtocol": "HTTP",
      "EndpointProtocolVersion": "HTTP1.1",
      "Description": "group1",
      "Name": "group1",
      "HealthCheckPort": 10,
      "HealthCheckEnabled": true,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "Tags": [
        {
          "Key": "test-key",
          "Value": "test-value"
        }
      ],
      "HealthCheckHost": "www.taobao.com",
      "EndpointIpVersion": "IPv4",
      "EndpointPrivateIpList": [
        {
          "PrivateIp": "172.19.115.37",
          "VSwitchId": "gsw-0jl6tmriqep1ga***",
          "CIDR": ""
        }
      ]
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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