トラフィックマーキングポリシーに関する情報を照会します。

使用上の注意

ListTrafficMarkingPolicies操作を呼び出すときは、次のルールに注意してください。

  • TrafficMarkingPolicyIdパラメーターでトラフィックマーキングポリシーIDを指定しない場合、システムはTransitRouterIdTrafficMarkingPolicyName、およびTrafficMarkingPolicyDescriptionパラメーターに基づいてトラフィックマーキングポリシーに関する情報を返します。 ポリシー内のトラフィック分類ルールに関する情報は返されません。 TrafficMatchRulesパラメーターは応答に含まれていません。
  • TrafficMarkingPolicyIdパラメーターでトラフィックマーキングポリシーIDを指定した場合、この操作はトラフィックマーキングポリシーとトラフィック分類ルールに関する情報を返します。 TrafficMatchRulesパラメーターがレスポンスに含まれています。

    TrafficMatchRulesパラメーターに空の配列が含まれている場合、トラフィックマーキングポリシーにトラフィック分類ルールが含まれていないことを示します。

デバッグ

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

リクエストパラメーター

項目 データ型 必須/任意 例: 説明 
操作 String 必須 ListTrafficMarkingPolicies

実行する操作です。 値をListTrafficMarkingPoliciesに設定します。

TransitRouterId String 必須 tr-bp1rmwxnk221e3fas ****

トランジットルーターのID。

TrafficMarkingPolicyId String 任意 tm-iz5egnyitxiroq ****

トラフィックマーキングポリシーのID。

TrafficMarkingPolicyName String 任意 nametest

トラフィックマーキングポリシーの名前。

名前は2 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。 先頭は英字とする必要があります。

TrafficMarkingPolicyDescription String 任意 desktest

トラフィックマーキングポリシーの説明。

説明は2 ~ 128文字で、英数字、アンダースコア (_) 、ハイフン (-) を使用できます。 説明は文字で始める必要があります。

MaxResults Integer いいえ 20

各ページで返されるエントリ数。 有効な値: 1100。 デフォルト値: 20

NextToken String 任意 FFmyTO70tTpLG6I3FmYAXGKPd ****

クエリの開始点を決定するトークン。 有効な値:

  • これが最初のクエリである場合、または後続のクエリを送信しない場合は、このパラメーターを無視します。
  • 後続のクエリを送信する場合は、前回の呼び出しから返されたNextTokenの値に値を設定します。

レスポンスパラメーター

項目 データ型 例: 説明 
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd ****

クエリの開始点を決定するトークン。

  • 前のクエリでNextTokenが返されなかった場合は、追加の結果が存在しないことを示します。
  • 前のクエリでNextTokenが返された場合は、値を指定して次の結果セットを取得します。
RequestId String 699989E4-64A0-5F78-8B93-CDB32D98971F

リクエストの ID です。

TotalCount Integer 1

返されたエントリの数。

MaxResults Integer 20

1 ページあたりで返されるエントリ数。

TrafficMarkingPolicies TrafficMarkingPolicyの配列

トラフィックマーキングポリシーに関する情報。

TrafficMarkingPolicyStatus String 作成中

トラフィックマーキングポリシーのステータス。 有効な値:

  • 作成中: ポリシーは作成中です。
  • 有効: ポリシーは使用可能です。
  • Modifying: ポリシーは変更中です。
  • Deleting: ポリシーは削除中です。
  • Deleted: ポリシーが削除されました。
TrafficMarkingPolicyId String tm-iz5egnyitxiroq ****

トラフィックマーキングポリシーのID。

MarkingDscp Integer 5

トラフィックマーキングポリシーの差別化サービスコードポイント (DSCP) 値。

TrafficMarkingPolicyName String nametest

トラフィックマーキングポリシーの名前。

Priority Integer 5

トラフィックマーキングポリシーの優先度。

数字が小さいほど、優先度が高くなります。

TrafficMarkingPolicyDescription String desktest

トラフィックマーキングポリシーの説明。

TrafficMatchRules TrafficMatchRuleの配列

トラフィック分類ルールに関する情報。

MatchDscp Integer 6

データパケットの照合に使用されるDSCP値。

DstCidr String 192.168.120.0/24

データパケットの照合に使用される宛先CIDRブロック。

TrafficMatchRuleDescription String desktest

トラフィック分類ルールの説明。

プロトコル String HTTP

データパケットの照合に使用されるプロトコル。

説明 トラフィックマーキングポリシーは複数のプロトコルをサポートします。 詳細については、CENのドキュメントをご参照ください。
TrafficMatchRuleId String tm-rule-fa9kgq1e90rmhc ****

トラフィック分類ルールのID。

SrcCidr String 192.168.10.0/24

データパケットの照合に使用されるソースCIDRブロック。

TrafficMatchRuleName String nametest

トラフィック分類ルールの名前。

TrafficMatchRuleStatus String 作成中

トラフィック分類ルールのステータス。 有効な値:

  • 作成中: ルールは作成中です。
  • 有効: ルールは使用可能です。
  • Deleting: ルールは削除中です。
  • Deleted: ルールは削除されます。
DstPortRange 整数の配列 80,80

データパケットの照合に使用される宛先ポート範囲。

2つの宛先ポート番号が返されます。

  • 宛先ポートが同じ、例えばポート80である場合、トラフィック分類ルールは、ポート80に送信されるデータパケットと一致する。

    宛先ポートが両方とも-1の場合、トラフィック分類ルールはすべてのデータパケットに一致します。

  • 宛先ポートが異なる場合、たとえばポート1とポート200の場合、トラフィック分類ルールは、宛先ポートがポート1からポート200の範囲にあるデータパケットを照合します。
SrcPortRange 整数の配列 1,200

データパケットの照合に使用される送信元ポート範囲。

2つの送信元ポート番号が返されます。

  • ソースポートが同じ、例えばポート80である場合、トラフィック分類ルールは、ポート80から送信されるデータパケットと一致する。

    ソースポートが両方とも-1の場合、トラフィック分類ルールはすべてのデータパケットに一致します。

  • ソースポートが異なる場合、例えば、ポート1とポート200の場合、トラフィック分類ルールは、ソースポートがポート1からポート200の範囲にあるデータパケットを照合する。

リクエストの例

http(s)://[Endpoint]/?Action=ListTrafficMarkingPolicies
&TransitRouterId=tr-bp1rmwxnk221e3fas ****
&TrafficMarkingPolicyId=tm-iz5egnyitxiroq ****
&TrafficMarkingPolicyName=nametest
&TrafficMarkingPolicyDescription=desctest
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd ****
&<共通リクエストパラメーター>

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

XML 形式

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

<ListTrafficMarkingPoliciesResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd ****</NextToken>
    <RequestId>699989E4-64A0-5F78-8B93-CDB32D98971F</RequestId>
    <トータルカウント> 6 </トータルカウント>
    <MaxResults>20</MaxResults>
    <TrafficMarkingPolicies>
        <TrafficMarkingPolicyStatus> 作成 </TrafficMarkingPolicyStatus>
        <TrafficMarkingPolicyId>tm-iz5egnyitxiroq ****</TrafficMarkingPolicyId>
        <MarkingDscp>5</MarkingDscp>
        <TrafficMarkingPolicyName> namestest </TrafficMarkingPolicyName>
        <Priority>5</Priority>
        <TrafficMarkingPolicyDescription>desctest</TrafficMarkingPolicyDescription>
        <TrafficMatchRules>
            <MatchDscp>6</MatchDscp>
            <DstCidr>192.168.120.0/24</DstCidr>
            <TrafficMatchRuleDescription>desctest</TrafficMatchRuleDescription>
            <プロトコル> HTTP</プロトコル>
            <TrafficMatchRuleId>tm-rule-fa9kgq1e90rmhc ****</TrafficMatchRuleId>
            <SrcCidr>192.168.10.0/24</SrcCidr>
            <TrafficMatchRuleName> namestest </TrafficMatchRuleName>
            <TrafficMatchRuleStatus> 作成 </TrafficMatchRuleStatus>
            <DstPortRange>80</DstPortRange>
            <DstPortRange>80</DstPortRange>
            <SrcPortRange>1</SrcPortRange>
            <SrcPortRange>200</SrcPortRange>
        </TrafficMatchRules>
    </TrafficMarkingPolicies>
</ListTrafficMarkingPoliciesResponse>

JSON 形式

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

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd ****" 、
  "RequestId" : "699989E4-64A0-5F78-8B93-CDB32D98971F" 、
  "TotalCount" : 6、
  "MaxResults" : 20、
  "TrafficMarkingPolicies" : [ {
    "TrafficMarkingPolicyStatus" : "作成" 、
    "TrafficMarkingPolicyId" : "tm-iz5egnyitxiroq ****" 、
    "MarkingDscp" : 5、
    "TrafficMarkingPolicyName" : "nametest" 、
    "優先度" : 5、
    "TrafficMarkingPolicyDescription" : "desktest" 、
    "TrafficMatchRules" : [ {
      "MatchDscp" : 6、
      "DstCidr" : "192.168.120.0/24" 、
      "TrafficMatchRuleDescription" : "desktest" 、
      "プロトコル" : "HTTP" 、
      "TrafficMatchRuleId" : "tm-rule-fa9kgq1e90rmhc ****" 、
      "SrcCidr" : "192.168.10.0/24" 、
      "TrafficMatchRuleName" : "nametest" 、
      "TrafficMatchRuleStatus" : "作成" 、
      "DstPortRange" : [ 80、80] 、
      "SrcPortRange" : [ 1, 200]
    } ]
  } ]
}

エラーコード

エラーコードのリストについては、エラーセンターをご覧ください。