ListForwardingRules - - Alibaba Cloud ドキュメントセンター

説明この操作は、デフォルトの転送ルールではなく、カスタム転送ルールのみを照会するために使用されます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター


項目	データ型	必須／任意	例:	説明
操作	String	必須	ListForwardingRules	実行する操作です。値をListForwardingRulesに設定します。
RegionId	String	必須	cn-hangzhou	Global Accelerator (GA) インスタンスがデプロイされているリージョンのID。値をcn-hangzhouに設定します。
ClientToken	String	任意	02fb3da4 ****	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 ClientTokenにはASCII文字のみを含めることができます。説明このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
ListenerId	String	必須	lsr-bp1s0vzbi5bxlx5pw ****	リスナーの ID を示します。
AcceleratorId	String	必須	ga-bp17frjjh0udz4qzk ****	GA インスタンスの ID です。
ForwardingRuleId	String	任意	frule-bp19a3t3yzr21q3 ****	転送ルールのID。
NextToken	String	任意	FFmyTO70tTpLG6I3FmYAXGKPd ****	クエリの開始点を決定するトークン。有効な値：これが最初のクエリである場合、または次のクエリを送信しない場合は、このパラメーターを無視します。後続のクエリを送信する場合は、前回の呼び出しから返されたNextTokenの値に値を設定します。
MaxResults	Integer	〇	20	各ページで返されるエントリ数。有効な値: 1〜100。デフォルト値: 20

レスポンスパラメーター


項目	データ型	例:	説明
RequestId	String	CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4	リクエストの ID です。
TotalCount	Integer	1	返されたエントリの総数。
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd ****	次のクエリの開始点を決定するトークン。有効な値： NextTokenが返されなかった場合は、追加の結果が存在しないことを示します。 NextTokenが返された場合、値は次のクエリで使用されるトークンを示します。
MaxResults	Integer	20	1 ページあたりで返されるエントリ数。
ForwardingRules	ForwardingRulesの配列		転送ルールに関する情報。
Priority	Integer	1000	転送ルールの優先度。有効な値: 1〜10000。値が小さいほど、優先度が高くなります。
ForwardingRuleId	String	frule-bp19a3t3yzr21q3 ****	転送ルールのID。
ForwardingRuleName	String	auto_named_rule	転送ルールの名前。
ForwardingRuleDirection	String	request	転送ルールが有効になる方向。デフォルトでは、requestが返されます。これは、転送ルールがリクエストに対して有効になることを示します。
ForwardingRuleStatus	String	active	転送ルールの状態。 active: 転送ルールは正常です。 configuring: 転送ルールは変更中です。 deleting: 転送ルールは削除中です。
ルール条件	RuleConditionsの配列		転送条件。
RuleConditionType	String	ホスト	転送条件のタイプ。ホスト: ドメイン名パス: パス RequestHeader: HTTPヘッダークエリ: クエリ文字列メソッド: HTTPメソッドクッキー: クッキー SourceIP: 送信元IPアドレス
RuleConditionValue	String	["www.example.com", "www.aliyun.com"]	転送条件タイプの値。 RuleConditionTypeパラメーターに基づいて、さまざまなJSON文字列が返されます。 RuleConditionTypeがHostに設定されている場合、ドメイン名の条件が返されます。転送条件で複数のドメイン名が返された場合、ドメイン名間の関係はORとなる。 RuleConditionTypeがPathに設定されている場合、パス条件が返されます。転送ルールでパスの種類が複数の転送条件が返された場合、転送条件の関係はORになります。転送条件で複数のパスが返された場合、パスの関係はORとなる。 If RuleConditionTypeが設定されます。 RequestHeaderの場合、Key-Value ペアからなる HTTP ヘッダー条件が返される。 RuleConditionTypeがQueryに設定されている場合、キーと値のペアで構成されるクエリ文字列条件が返されます。 RuleConditionTypeがMethodに設定されている場合、HTTPメソッド条件が返されます。 RuleConditionTypeがCookieに設定されている場合、キーと値のペアで構成されるcookie条件が返されます。 RuleConditionTypeがSourceIPに設定されている場合、送信元IPアドレス条件が返されます。転送条件で複数の送信元IPアドレスが返された場合、送信元IPアドレス間の関係はORです。
PathConfig	オブジェクト		パスの設定。
値	文字列の配列	/テスト	パス。パスの長さは1 ~ 128文字で、先頭はスラッシュ (/) である必要があります。パスには、英字、数字、および次の特殊文字のみを含めることができます: $ - _。 + / & ~ @ : '. サポートされているワイルドカード文字は、アスタリスク (*) と疑問符 (?) です。
HostConfig	オブジェクト		ドメイン名の設定。
値	文字列の配列	www.example.com	ドメイン名。ドメイン名は3 ~ 128文字で、英数字、ハイフン (-) 、ピリオド (.) を使用できます。サポートされているワイルドカード文字は、アスタリスク (*) と疑問符 (?) です。
ルールアクション	RuleActionsの配列		転送アクション。
順序	Integer	1	転送の優先度。説明このパラメータは有効になりません。
RuleActionType	String	ForwardGroup	転送アクションのタイプ。有効な値： ForwardGroup: リクエストを転送します。リダイレクト: リクエストをリダイレクトします。 FixResponse: 固定応答を返します。書き換え: リクエストを書き換えます。 AddHeader: リクエストにヘッダーを追加します。 RemoveHeaderConfig: リクエストのヘッダーを削除します。
RuleActionValue	String	[{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r ****"}]	転送アクションタイプの値。 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が書き換えに設定されている場合、書き換え設定が返されます。次のリストでパラメーターについて説明します。 `domain`: リクエストのリダイレクト先のドメイン名。 `path`: リクエストのリダイレクト先のパス。 `query`: the query string of the requests that are redirected.
ForwardGroupConfig	オブジェクト		転送アクションの設定。
ServerGroupTuples	ServerGroupTuplesの配列		エンドポイントグループに関する情報。
EndpointGroupId	String	epg-bp1enpdcrqhl78g6r ****	エンドポイントグループの ID。
ListenerId	String	lsr-bp1s0vzbi5bxlx5 ****	リスナーの ID を示します。

例

リクエストの例

http(s)://[Endpoint]/?Action=ListForwardingRules
&RegionId=cn-hangzhou
&ClientToken=02fb3da4 ****
&ListenerId=lsr-bp1s0vzbi5bxlx5pw ****
&AcceleratorId=ga-bp17frjjh0udz4qzk ****
&ForwardingRuleId=frule-bp19a3t3yzr21q3 ****
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd ****
&MaxResults=20
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListForwardingRulesResponse>
    <RequestId>CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4</RequestId>
    <TotalCount> 1 </ TotalCount>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd ****</NextToken>
    <MaxResults>20</MaxResults>
    <ForwardingRules>
        <Priority>1000</Priority>
        <ForwardingRuleId>frule-bp19a3t3yzr21q3 ****</ForwardingRuleId>
        <ForwardingRuleName>auto_named_rule</ForwardingRuleName>
        <ForwardingRuleDirection> リクエスト </ForwardingRuleDirection>
        <ForwardingRuleStatus>active</ForwardingRuleStatus>
        <RuleConditions>
            <RuleConditionType> ホスト </RuleConditionType>
            <RuleConditionValue>["www.example.com" 、"www.aliyun.com"]</RuleConditionValue>
            <PathConfig>
                <Values>/test</Values>
            </PathConfig>
            <HostConfig>
                <値s>www.example.com</値>
            </HostConfig>
        </RuleConditions>
        <RuleActions>
            <注文> 1</注文>
            <RuleActionType>ForwardGroup</RuleActionType>
            <RuleActionValue>[{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}]</RuleActionValue>
            <ForwardGroupConfig>
                <ServerGroupTuples>
                    <EndpointGroupId>epg-bp1enpdcrqhl78g6r ****</EndpointGroupId>
                </ServerGroupTuples>
            </ForwardGroupConfig>
        </RuleActions>
        <ListenerId>lsr-bp1s0vzbi5bxlx5 ****</ListenerId>
    </ForwardingRules>
</ListForwardingRulesResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4" 、
  "TotalCount" : 1、
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd ****" 、
  "MaxResults" : 20、
  "ForwardingRules" : [ {
    "優先度" : 1000、
    "ForwardingRuleId" : "frule-bp19a3t3yzr21q3 ****" 、
    "ForwardingRuleName" : "auto_named_rule" 、
    "ForwardingRuleDirection" : "request" 、
    "ForwardingRuleStatus" : "active" 、
    "RuleConditions" : [ {
      "RuleConditionType" : "ホスト" 、
      "RuleConditionValue" : "[\" www.example.com\"、\" www.aliyun.com\"]" 、
      "PathConfig" : {
        "Values" : [ "/test"]
      },
      "HostConfig" : {
        "値" : [ "www.example.com"]
      }
    } ],
    "RuleActions" : [ {
      "注文" : 1、
      "RuleActionType" : "ForwardGroup" 、
      "RuleActionValue" : "[{\" type\":\" endpointgroup\", \" value\":\" epg-bp1enpdcrqhl78g6r ****\"}]" 、
      "ForwardGroupConfig" : {
        "ServerGroupTuples" : [ {
          "EndpointGroupId" : "epg-bp1enpdcrqhl78g6r ****"
        } ]
      }
    } ],
    "ListenerId" : "lsr-bp1s0vzbi5bxlx5 ****"
  } ]
}

エラーコード


HttpCode	エラーコード	エラーメッセージ	説明
400	NotExist.Listener	リスナーが存在しません。	指定されたリスナーが存在しない場合に返されるエラーメッセージ。
400	NotActive.Listener	リスナーの状態がアクティブではありません。	指定されたリスナーが不安定な場合に返されるエラーメッセージ。
400	NotExist.Accelerator	高速化されたインスタンスは存在しません。	指定されたGAインスタンスが存在しない場合に返されるエラーメッセージ。
400	NotExist.BusinessRegion	ビジネスリージョンは存在しません。	指定されたリージョンが存在しない場合に返されるエラーメッセージ。
400	NotExist.BasicBandwidthPackage	基本帯域幅パッケージを指定する必要があります。	基本帯域幅プランが指定されていない場合に返されるエラーメッセージ。
400	QuotaExceeded.EndPoint	エンドポイントの最大数を超えています。	エンドポイントの数が上限に達した場合に返されるエラーメッセージ。
400	存在します。EndpointGroup	エンドポイントグループは既に存在します。	指定されたエンドポイントグループが既に存在する場合に返されるエラーメッセージ。
400	NoPermission.VpcEndpoint	操作を実行する権限がありません。	サービスにリンクされたロールを作成する権限がない場合に返されるエラーメッセージ。 Alibaba Cloudアカウントの所有者または管理者に連絡して、AliyunGlobalAccelerationFullAccessポリシー、または必要なサービスにリンクされたロールを作成するための権限をRAMユーザーに付与するカスタム権限ポリシーをアタッチしてください。カスタムポリシーでは、サービス名をo vpcendpoint.ga.aliyuncs.comに、サービスにリンクされたロールをAliyunServiceRoleForGaVpcEndpointに、権限をram:CreateServiceLinkedRoleに設定する必要があります。

エラーコードリストについては、「API エラーセンター」をご参照ください。