ListForwardingRules を使用して転送ルールをクエリする - 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:ListForwardingRules

list

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Global Accelerator (GA) インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	02fb3da4****
ListenerId	string	必須	リスナーの ID。	lsr-bp1s0vzbi5bxlx5pw****
AcceleratorId	string	必須	GA インスタンスの ID。	ga-bp17frjjh0udz4qzk****
ForwardingRuleId	string	任意	転送ルールの ID。	frule-bp19a3t3yzr21q3****
NextToken	string	任意	次のクエリに使用されるトークン。有効な値：最初のクエリであるか、後続のクエリを送信しない場合は、このパラメーターを無視してください。次のクエリを送信する場合は、最後の呼び出しから返された NextToken の値に設定します。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	任意	1 ページあたりのエントリ数。有効な値：1～100。デフォルト値：20。	20

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエストの ID。	CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4
TotalCount	integer	返されたエントリの数。	1
NextToken	string	次のクエリに使用されるトークン。有効な値： NextToken が返されない場合、追加の結果がないことを示します。 NextToken が返された場合、その値は次のクエリに使用されるトークンを示します。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	1 ページあたりに返されるエントリ数。	20
ForwardingRules	array<object>	転送ルール。
	array<object>	転送ルール。
Priority	integer	転送ルールの優先度。 1～10000 の値が返されます。値が小さいほど、優先度が高くなります。	1000
ForwardingRuleId	string	転送ルール ID。	frule-bp19a3t3yzr21q3****
ForwardingRuleName	string	転送ルール名。	auto_named_rule
ForwardingRuleDirection	string	転送ルールが有効になる方向。デフォルトでは request が返され、転送ルールがリクエストに対して有効になることを示します。	request
ForwardingRuleStatus	string	転送ルールの状態。有効な値： active：転送ルールは正常です。 configuring：転送ルールは変更中です。 deleting：転送ルールは削除中です。	active
RuleConditions	array<object>	転送ルールをトリガーする条件。
	array<object>	転送条件。
RuleConditionType	string	転送条件のタイプ。有効な値： Host：ドメイン名。 Path：パス。 RequestHeader：HTTP ヘッダー。 Query：クエリ文字列。 Method：HTTP メソッド。 Cookie：Cookie。 SourceIP：送信元 IP アドレス。	Host
RuleConditionValue	string	転送条件タイプの値。 RuleConditionType パラメーターの値に基づいて、異なる JSON 文字列が返されます。 RuleConditionType を Host に設定すると、ドメイン名条件が返されます。1 つの転送条件で複数のドメイン名が返された場合、ドメイン名間の関係は OR です。 RuleConditionType を Path に設定すると、パス条件が返されます。1 つの転送ルールでパスタイプの複数の転送条件が返された場合、転送条件間の関係は OR です。1 つの転送条件で複数のパスが返された場合、パス間の関係は OR です。 RuleConditionType を RequestHeader に設定すると、キーと値のペアで構成される HTTP ヘッダー条件が返されます。 RuleConditionType を Query に設定すると、キーと値のペアで構成されるクエリ文字列条件が返されます。 RuleConditionType を Method に設定すると、HTTP メソッド条件が返されます。 RuleConditionType を Cookie に設定すると、キーと値のペアで構成される Cookie 条件が返されます。 RuleConditionType を SourceIP に設定すると、送信元 IP アドレス条件が返されます。1 つの転送条件で複数の送信元 IP アドレスが返された場合、送信元 IP アドレス間の関係は OR です。	["www.example.com", "www.aliyun.com"]
PathConfig	object	パス設定。説明 2022 年 7 月 12 日以降に作成された GA インスタンスは、すべての転送条件タイプとアクションタイプをサポートします。RuleActionType および RuleActionValue 操作を呼び出して、転送条件とアクションを照会することを推奨します。
Values	array	パス設定。説明 2022 年 7 月 12 日以降に作成された GA インスタンスは、すべての転送条件タイプとアクションタイプをサポートします。RuleActionType および RuleActionValue 操作を呼び出して、転送条件とアクションを照会することを推奨します。
	string	パス。パスは 1～128 文字の長さで、スラッシュ (/) で始まる必要があります。パスには、文字、数字、および次の特殊文字のみを含めることができます：$ - _ . + / & ~ @ : '。サポートされているワイルドカード文字は、アスタリスク () と疑問符 (?) です。説明 2022 年 7 月 12 日以降に作成された GA インスタンスは、すべての転送条件タイプとアクションタイプをサポートします。RuleActionType* および RuleActionValue 操作を呼び出して、転送条件とアクションを照会することを推奨します。	/test
HostConfig	object	ドメイン名設定。説明 2022 年 7 月 12 日以降に作成された GA インスタンスは、すべての転送条件タイプとアクションタイプをサポートします。RuleActionType および RuleActionValue 操作を呼び出して、転送条件とアクションを照会することを推奨します。
Values	array	ドメイン名設定。説明 2022 年 7 月 12 日以降に作成された GA インスタンスは、すべての転送条件タイプとアクションタイプをサポートします。RuleActionType および RuleActionValue 操作を呼び出して、転送条件とアクションを照会することを推奨します。
	string	ドメイン名。ドメイン名は 3～128 文字の長さで、文字、数字、ハイフン (-)、ピリオド (.) を含めることができます。サポートされているワイルドカード文字は、アスタリスク () と疑問符 (?) です。説明 2022 年 7 月 12 日以降に作成された GA インスタンスは、すべての転送条件タイプとアクションタイプをサポートします。RuleActionType* および RuleActionValue 操作を呼び出して、転送条件とアクションを照会することを推奨します。	www.example.com
RuleActions	array<object>	転送アクション。
	array<object>	転送アクション。
Order	integer	転送の優先度。説明このパラメーターは有効になりません。	1
RuleActionType	string	転送アクションのタイプ。有効な値： ForwardGroup：リクエストを転送します。 Redirect：リクエストをリダイレクトします。 FixResponse：固定レスポンスを返します。 Rewrite：リクエストを書き換えます。 AddHeader：リクエストにヘッダーを追加します。 RemoveHeaderConfig：リクエストからヘッダーを削除します。 Drop：リクエストをドロップします。	ForwardGroup
RuleActionValue	string	転送アクションの値。 RuleActionType の値に基づいて、異なる JSON 文字列が返されます。 RuleActionType を ForwardGroup に設定すると、仮想エンドポイントグループに関する情報が返されます。次のセクションでは、パラメーターについて説明します： `type`：`endpointgroup` が返されます。 `value`：仮想エンドポイントグループの ID。 RuleActionType を Redirect に設定すると、リダイレクト設定が返されます。次のセクションでは、パラメーターについて説明します： `protocol`：リクエストがリダイレクトされた後のリクエストのプロトコル。 `domain`：リクエストがリダイレクトされるドメイン名。 `port`：リクエストがリダイレクトされるポート。 `path`：リクエストがリダイレクトされるパス。 `query`：リダイレクトされるリクエストのクエリ文字列。 `code`：リダイレクトコード。 RuleActionType を FixResponse に設定すると、設定した固定レスポンスに関する情報が返されます。次のセクションでは、パラメーターについて説明します： `code`：HTTP ステータスコード。 `type`：レスポンスのコンテンツタイプ。 `content`：レスポンスのコンテンツ。 RuleActionType が AddHeader に設定されている場合、追加された HTTP ヘッダーに関する情報が返されます。次のセクションでは、パラメーターについて説明します： `name`：HTTP ヘッダーの名前。 `type`：HTTP ヘッダーのコンテンツタイプ。 `value`：HTTP ヘッダーのコンテンツ。 RuleActionType を RemoveHeader に設定すると、削除された HTTP ヘッダーに関する情報が返されます。 RuleActionType を Rewrite に設定すると、書き換え設定が返されます。次のセクションでは、パラメーターについて説明します： `domain`：リクエストがリダイレクトされるドメイン名。 `path`：リクエストがリダイレクトされるパス。 `query`：リダイレクトされるリクエストのクエリ文字列。 RuleActionType を Drop に設定すると、空の文字列が返されます。	[{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}]
ForwardGroupConfig	object	転送アクション設定。説明 2022 年 7 月 12 日以降に作成された GA インスタンスは、すべての転送条件タイプとアクションタイプをサポートします。RuleActionType および RuleActionValue 操作を呼び出して、転送条件とアクションを照会することを推奨します。
ServerGroupTuples	array<object>	エンドポイントグループに関する情報。説明 2022 年 7 月 12 日以降に作成された GA インスタンスは、すべての転送条件タイプとアクションタイプをサポートします。RuleActionType および RuleActionValue 操作を呼び出して、転送条件とアクションを照会することを推奨します。
	object	エンドポイントグループに関する情報。説明 2022 年 7 月 12 日以降に作成された GA インスタンスでは、すべての転送条件タイプと転送アクションタイプがサポートされます。RuleActionType と RuleActionValue を呼び出して転送アクションを照会することを推奨します。
EndpointGroupId	string	エンドポイントグループ ID。説明 2022 年 7 月 12 日以降に作成された GA インスタンスは、すべての転送条件タイプとアクションタイプをサポートします。RuleActionType および RuleActionValue 操作を呼び出して、転送条件とアクションを照会することを推奨します。	epg-bp1enpdcrqhl78g6r****
ListenerId	string	リスナー ID。	lsr-bp1s0vzbi5bxlx5****
ServiceId	string	インスタンスを管理するサービスの ID。説明このパラメーターは、ServiceManaged の値が true の場合にのみ返されます。	ALB
ServiceManaged	boolean	GA インスタンスが管理されているかどうかを示します。有効な値： true：GA インスタンスは管理されています。 false：GA インスタンスは管理されていません。	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": "CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4",
  "TotalCount": 1,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20,
  "ForwardingRules": [
    {
      "Priority": 1000,
      "ForwardingRuleId": "frule-bp19a3t3yzr21q3****",
      "ForwardingRuleName": "auto_named_rule",
      "ForwardingRuleDirection": "request",
      "ForwardingRuleStatus": "active",
      "RuleConditions": [
        {
          "RuleConditionType": "Host",
          "RuleConditionValue": "[\"www.example.com\", \"www.aliyun.com\"]",
          "PathConfig": {
            "Values": [
              "/test"
            ]
          },
          "HostConfig": {
            "Values": [
              "www.example.com"
            ]
          }
        }
      ],
      "RuleActions": [
        {
          "Order": 1,
          "RuleActionType": "ForwardGroup",
          "RuleActionValue": "[{\"type\":\"endpointgroup\", \"value\":\"epg-bp1enpdcrqhl78g6r****\"}]",
          "ForwardGroupConfig": {
            "ServerGroupTuples": [
              {
                "EndpointGroupId": "epg-bp1enpdcrqhl78g6r****"
              }
            ]
          }
        }
      ],
      "ListenerId": "lsr-bp1s0vzbi5bxlx5****",
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	NotExist.Listener	The listener does not exist.	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.	The state of the listener is not active.
400	NotExist.Accelerator	The accelerated instance does not exist.	The accelerated instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.
400	NotExist.BusinessRegion	The business region does not exist.	The business region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	The maximum number of endpoints is exceeded.
400	Exist.EndpointGroup	The endpoint group already exists.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.

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

変更履歴

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