ListCustomRoutingPortMappings を使用してカスタムルーティングリスナーのポートマッピングテーブルをクエリする - GA

この操作は、カスタムルーティングリスナーのポートマッピングテーブルを照会します。

操作説明

カスタムルーティングリスナーとエンドポイントグループを設定した後、Global Accelerator インスタンスはポートマッピングテーブルを生成します。このテーブルは、リスナーポート範囲、宛先エンドポイントグループのプロトコルとポート範囲、およびエンドポイント（vSwitch）の IP アドレスに基づいています。カスタムルーティングリスナーは、このポートマッピングテーブルを使用して、vSwitch 内の特定の IP アドレスとポートへのトラフィックを決定論的にルーティングします。この操作を呼び出して、生成されたポートマッピングテーブルを照会できます。

今すぐお試しください

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

list

*CustomRoutingPortMapping

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

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
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****
EndpointGroupId	string	任意	ポートマッピングテーブルを照会するエンドポイントグループの ID。	epg-bp16jdc00bhe97sr5****

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	返された情報の一覧。
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	返されたエントリの総数。	1
PageSize	integer	1 ページあたりに返されるエントリ数。	10
PageNumber	integer	ページ番号。	1
PortMappings	array<object>	ポートマッピングに関する情報。
	object	ポートマッピングに関する情報。
AcceleratorId	string	ポートマッピングが属する Global Accelerator インスタンスの ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	ポートマッピングが属するカスタムルーティングリスナーの ID。	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	エンドポイントグループの ID。	epg-bp14sz7ftcwwjgrdm****
EndpointId	string	エンドポイントの ID。	ep-bp14sz7ftcwwjgrdm****
EndpointGroupRegion	string	エンドポイントグループが属するリージョンの ID。	us-west-1
Vswitch	string	エンドポイントの vSwitch の名前。	vsw-test01
AcceleratorPort	integer	アクセラレーションポート。	3000
Protocols	array	バックエンドサービスのプロトコル。 TCP：TCP プロトコル。 UDP：UDP プロトコル。
	string	バックエンドサービスのプロトコル。 TCP：TCP プロトコル。 UDP：UDP プロトコル。	tcp
DestinationTrafficState	string	バックエンドインスタンストラフィックポリシー。 allow：バックエンドインスタンスがトラフィックを受信できるようにします。 deny：バックエンドインスタンスがトラフィックを受信できないようにします。	allow
DestinationSocketAddress	object	バックエンドサービスの IP アドレスとポート。
IpAddress	string	バックエンドサービスの IP アドレス。	10.0.XX.XX
Port	integer	バックエンドサービスのポート。	443

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "PortMappings": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "EndpointGroupRegion": "us-west-1",
      "Vswitch": "vsw-test01",
      "AcceleratorPort": 3000,
      "Protocols": [
        "TCP"
      ],
      "DestinationTrafficState": "allow",
      "DestinationSocketAddress": {
        "IpAddress": "10.0.XX.XX",
        "Port": 443
      }
    }
  ]
}

エラーコード

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

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

変更履歴

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