すべてのプロダクト
Search

このプロダクト

    Global Accelerator:ListEndpointGroups

    ドキュメントセンター

    Global Accelerator:ListEndpointGroups

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

    list

    *EndpointGroup

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    Global Accelerator インスタンスがデプロイされているリージョンの ID です。値を cn-hangzhou に設定します。

    cn-hangzhou
    PageNumber

    integer

    任意

    ページ番号です。デフォルト値は 1 です。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数です。最大値は 50、デフォルト値は 10 です。

    10
    AcceleratorId

    string

    必須

    Global Accelerator インスタンスの 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>

    任意

    エンドポイントグループをフィルターするために使用するタグです。最大 20 個のタグを指定できます。

    object

    任意

    タグです。

    Key

    string

    任意

    タグキーです。タグキーは空文字列にできません。

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

    test-key
    Value

    string

    任意

    タグ値です。タグ値は空文字列にできます。

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

    test-value

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスデータです。

    TotalCount

    integer

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

    1
    PageSize

    integer

    1 ページあたりに返されるエントリ数です。

    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 アドレスのリストです。

    重要 プライベートバックエンドサービスに接続されたエンドポイントグループの場合、コンソールにはパブリック IP アドレスではなくプライベート送信元 IP アドレスのみが表示されます。バックエンドサービスの接続タイプが変更された場合（例：プライベートからパブリックへ）、送信元 IP アドレスを監視し、バックエンドサービスのアクセス制御リスト (ACL) を更新してください。

    string

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

    47.1.XX.XX
    EndpointGroupUnconfirmedIpList

    array

    Global Accelerator インスタンスのスペックアップ後に確認が必要なエンドポイントグループ内の新しい IP アドレスのリストです。

    string

    Global Accelerator インスタンスのスペックアップ後に確認が必要なエンドポイントグループ内の新しい IP アドレスです。

    47.1.XX.XX
    State

    string

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

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

    • active： エンドポイントグループは安定しています。

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

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

    active
    HealthCheckPath

    string

    ヘルスチェックパスです。

    /healthcheck
    EndpointGroupRegion

    string

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

    cn-hangzhou
    HealthCheckIntervalSeconds

    integer

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

    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

    Global Accelerator インスタンスの 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 のエラスティックネットワークインターフェース。

    • 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： Proxy Protocol が有効になります。

    • false： Proxy Protocol が無効になります。

    ProbePort

    integer

    遅延モニタリングプローブに使用されるポートです。

    80
    EndpointId

    string

    エンドポイントの ID です。

    ep-bp1d2utp8qqe2a44t****
    SubAddress

    string

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

    172.168.XX.XX
    VpcId

    string

    VPC の ID です。

    vpc-8vbhucmd5b2q2fpqqu****
    VSwitchIds

    array

    VPC 内の vSwitch のリストです。

    string

    vSwitch の ID です。

    vsw-hp3xwc2aebg2u30ln****
    Provider

    string

    サービスプロバイダーです。

    BAILIAN
    ApiKeys

    array

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

    string

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

    sk-*******
    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 (デフォルト)： バックエンドサービスへの接続に IPv4 を使用します。

    • IPv6： バックエンドサービスへの接続に IPv6 を使用します。

    • ProtocolAffinity： バックエンドサービスへの接続に、クライアントリクエストと同じ IP プロトコルを使用します。

    IPv4
    EndpointPrivateIpList

    array<object>

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

    object

    PrivateIp

    string

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

    172.19.115.37
    VSwitchId

    string

    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****"
          ],
          "Provider": "BAILIAN",
          "ApiKeys": [
            "sk-*******"
          ]
        }
      ],
      "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.

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

    変更履歴

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