Global Accelerator における Custom Routing Endpoints の概要 - GA

エンドポイントの構成を照会します。

今すぐお試しください

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

list

*CustomRoutingEndpoint

acs:ga:*:{#accountId}:ga/{#gaId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Global Accelerator (GA) インスタンスが配置されているリージョン ID。値を cn-hangzhou に設定します。	cn-hangzhou
PageNumber	integer	任意	ページ番号。デフォルト値：1。	1
PageSize	integer	任意	1ページあたりのエントリ数。有効値の範囲：1～50。デフォルト値：10。	10
AcceleratorId	string	必須	GA インスタンスの ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	任意	リスナーの ID。	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	任意	エンドポイントグループの ID。	epg-bp16jdc00bhe97sr5****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	返されたエントリの総数。	10
PageSize	integer	1ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
Endpoints	array<object>	エンドポイントに関する情報。
	array<object>
AcceleratorId	string	エンドポイントが関連付けられている GA インスタンスの ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	エンドポイントが属するリスナーの ID。	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	エンドポイントが属するエンドポイントグループの ID。	epg-bp16jdc00bhe97sr5****
EndpointId	string	エンドポイント ID。	ep-bp14sz7ftcwwjgrdm****
Type	string	エンドポイントのバックエンドサービスタイプ。 PrivateSubNet のみが返される場合があります。これはプライベート CIDR ブロックを示します。	PrivateSubNet
Endpoint	string	エンドポイントとして指定されている vSwitch の名前。	vsw-test01
TrafficToEndpointPolicy	string	エンドポイント宛てのトラフィックのアクセスポリシー。有効な値： AllowAll：エンドポイントへのすべてのトラフィックを許可します。 DenyAll：エンドポイントへのすべてのトラフィックを拒否します。 AllowCustom：指定された宛先へのトラフィックのみを許可します。	DenyAll
ServiceId	string	GA インスタンスを管理するサービスの ID。説明このパラメーターは、ServiceManaged が True に設定されている場合にのみ有効です。	ALB
ServiceManaged	boolean	GA インスタンスが管理されているかどうかを示します。有効な値： 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

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 10,
  "PageSize": 10,
  "PageNumber": 1,
  "Endpoints": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "EndpointGroupId": "epg-bp16jdc00bhe97sr5****",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "Type": "PrivateSubNet",
      "Endpoint": "vsw-test01",
      "TrafficToEndpointPolicy": "DenyAll",
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	NoPermission	No permissions.

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

変更履歴

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