Global Accelerator:ListEndpointGroups - GA - Alibaba Cloud - Global Accelerator

エンドポイントグループのリストを照会します。

今すぐお試しください

この 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	任意	ページングクエリの 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。	10
AcceleratorId	string	必須	Alibaba Cloud Global Accelerator (GA) インスタンスのインスタンス ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	任意	リスナーのインスタンス ID。	lsr-bp1bpn0kn908w4nbw****
EndpointGroupType	string	任意	エンドポイントグループのタイプ。有効な値: default: デフォルトエンドポイントグループ。 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-値
EndpointGroupRegion	string	任意

レスポンスフィールド

フィールド	型	説明	例
	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 アドレスは表示されなくなります。バックエンドサービスのネットワーク接続性タイプが変更された場合 (たとえば、プライベートネットワークからパブリックネットワークへ、またはプライベートネットワークとパブリックネットワークのハイブリッドバックツーオリジンへの変更)、バックツーオリジンアドレスの変更を速やかに確認し、それに応じてバックエンドサービスの ACL を同期して更新してください。
	string	エンドポイントグループのパブリック IP アドレスのリスト。	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	Alibaba Cloud Global Accelerator (GA) インスタンスのアップグレード後に追加された、未確認のエンドポイントグループ IP アドレスのリスト。
	string	Alibaba Cloud Global Accelerator (GA) インスタンスのアップグレード後に追加された、未確認のエンドポイントグループ IP アドレスのリスト。	47.1.XX.XX
State	string	エンドポイントグループのステータス。有効な値: init: エンドポイントグループを初期化中です。 active: エンドポイントグループはアクティブな状態で実行中です。 updating: エンドポイントグループを更新中です。 deleteing: エンドポイントグループを削除中です。	アクティブな
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	Alibaba Cloud Global Accelerator (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 エラスティックネットワークインターフェース (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	ProxyProtocol メソッドを使用してクライアント IP アドレスの保持が有効になっているかどうかを示します。有効な値: true: ProxyProtocol メソッドを使用してクライアント IP アドレスの保持が有効になっています。 false: ProxyProtocol メソッドを使用したクライアント IP アドレスの保持は有効になっていません。
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****
Provider	string	プロバイダー情報。	BAILIAN
ApiKeys	array	エンドポイント設定内の API キー。
	string	エンドポイントグループ内の最初の API キー。	sk-*******
PortOverrides	array<object>	ポートマッピング情報。
	object	ポートマッピング情報。
ListenerPort	integer	リスナーポート。	443
EndpointPort	integer	エンドポイントポート。	80
ForwardingRuleIds	array	エンドポイントグループに関連付けられている転送ルールの ID。
	string	エンドポイントグループに関連付けられている転送ルールの ID。	fルール-bp19a3t3yzr21q3****
EndpointGroupType	string	エンドポイントグループタイプ。有効な値: default: デフォルトエンドポイントグループ。 virtual: 仮想エンドポイントグループ。	デフォルト
EndpointRequestProtocol	string	バックエンドサービスプロトコル。有効な値: HTTP: HTTP。 HTTPS: HTTPS。	HTTP
EndpointProtocolVersion	string	バックエンドサービスプロトコルバージョン。有効な値: HTTP1.1: HTTP 1.1。 HTTP2: HTTP 2。	HTTP1.1
Description	string	エンドポイントグループの説明。	グループ1
Name	string	エンドポイントグループの名前。	グループ1
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: 管理ポリシー操作は管理されています。ユーザーは、ホストインスタンスに対して Action で指定された操作を実行できません。 false: 管理ポリシー操作は管理されていません。ユーザーは、ホストインスタンスに対して Action で指定された操作を実行できます。	false
Tags	array<object>	エンドポイントグループのタグ。
	object	エンドポイントグループのタグ。
Key	string	エンドポイントグループのタグキー。	test-key
Value	string	エンドポイントグループのタグ値。	test-値
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
HealthCheckSuccessCodes	string
HealthCheckMethod	string
ProxyTunnel	object
ConnectAuthPrefix	string
ConnectAuthSuffix	string
ConnectSessionHashHdr	string
ConnectTunnelTimeout	integer
TunnelServerPort	integer
TunnelServerType	string
TunnelServer	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": ""
        }
      ],
      "HealthCheckSuccessCodes": "",
      "HealthCheckMethod": "",
      "ProxyTunnel": {
        "ConnectAuthPrefix": "",
        "ConnectAuthSuffix": "",
        "ConnectSessionHashHdr": "",
        "ConnectTunnelTimeout": 0,
        "TunnelServerPort": 0,
        "TunnelServerType": "",
        "TunnelServer": ""
      }
    }
  ]
}

エラーコード

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.

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

変更履歴

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