トラフィックマーキングポリシーのステータスや優先度など、トラフィックマーキングポリシーの詳細を照会します。
操作説明
ListTrafficMarkingPolicies 操作を呼び出す際:
TransitRouterId および TrafficMarkingPolicyId パラメーターのうち、少なくとも 1 つを指定する必要があります。
トラフィックマーキングポリシー ID を指定しない場合 (つまり、TrafficMarkingPolicyId パラメーターに値を指定しない場合)、この操作は TransitRouterId、TrafficMarkingPolicyName、および TrafficMarkingPolicyDescription パラメーターの値に基づいてトラフィックマーキングポリシー情報のみを返します。トラフィックマーキングポリシー配下のトラフィック分類ルール情報は返されません (つまり、応答に TrafficMatchRules フィールドが含まれません)。
トラフィックマーキングポリシー ID を指定する場合 (つまり、TrafficMarkingPolicyId パラメーターに値を指定する場合)、この操作はトラフィックマーキングポリシー情報と、そのトラフィックマーキングポリシー配下のトラフィック分類ルール情報を返します (つまり、応答に TrafficMatchRules フィールドが含まれます)。 TrafficMatchRules フィールドが空の配列である場合、現在のトラフィックマーキングポリシー配下にはトラフィック分類ルールが存在しません。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cen:ListTrafficMarkingPolicies |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| TransitRouterId |
string |
任意 |
トランジットルーターインスタンスの ID。 |
tr-bp1rmwxnk221e3fas**** |
| TrafficMarkingPolicyId |
string |
任意 |
トラフィックマーキングポリシーの ID。 |
tm-iz5egnyitxiroq**** |
| TrafficMarkingPolicyName |
string |
任意 |
トラフィックマーキングポリシーの名前。 名前は空でもよく、長さは 1~128 文字で、http:// または https:// で始まることはできません。 |
nametest |
| TrafficMarkingPolicyDescription |
string |
任意 |
トラフィックマーキングポリシーの説明。 説明は空でもよく、長さは 1~256 文字で、http:// または https:// で始まることはできません。 |
desctest |
| MaxResults |
integer |
任意 |
ページングクエリの 1 ページあたりのエントリ数。有効な値: 1~100。デフォルト値: 20。 |
20 |
| NextToken |
string |
任意 |
ページネーショントークン。有効な値:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| NextToken |
string |
ページネーショントークン。
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| RequestId |
string |
リクエスト ID。 |
699989E4-64A0-5F78-8B93-CDB32D98971F |
| TotalCount |
integer |
返されたエントリの総数。 |
1 |
| MaxResults |
integer |
ページングクエリの 1 ページあたりのエントリ数。 |
20 |
| TrafficMarkingPolicies |
array<object> |
トラフィックマーキングポリシーのリスト。 |
|
|
array<object> |
トラフィックマーキングポリシーの情報。 |
||
| TrafficMarkingPolicyStatus |
string |
トラフィックマーキングポリシーのステータス。
|
Creating |
| TrafficMarkingPolicyId |
string |
トラフィックマーキングポリシーの ID。 |
tm-iz5egnyitxiroq**** |
| MarkingDscp |
integer |
トラフィックマーキングポリシーの DSCP 値。 |
5 |
| TrafficMarkingPolicyName |
string |
トラフィックマーキングポリシーの名前。 |
nametest |
| Priority |
integer |
トラフィックマーキングポリシーの優先度。 値が小さいほど優先度が高くなります。 |
5 |
| TrafficMarkingPolicyDescription |
string |
トラフィックマーキングポリシーの説明。 |
desctest |
| TrafficMatchRules |
array<object> |
トラフィック分類ルールのリスト。 |
|
|
object |
トラフィック分類ルールの情報。 |
||
| MatchDscp |
integer |
トラフィックパケットの DSCP 値。 説明
MatchDscp の値が -1 の場合、任意の DSCP 値に一致します。 |
6 |
| DstCidr |
string |
トラフィックパケットの送信先 CIDR ブロック。IPv4 および IPv6 アドレスがサポートされています。 |
192.168.120.0/24 |
| TrafficMatchRuleDescription |
string |
トラフィック分類ルールの説明。 |
desctest |
| Protocol |
string |
トラフィックパケットのプロトコルの種類。 説明
トラフィックマーキングポリシーは複数のプロトコルの種類のマッチングをサポートしています。各プロトコルの種類の詳細については、関連ドキュメントを参照してください。 |
HTTP |
| TrafficMatchRuleId |
string |
トラフィック分類ルールの ID。 |
tm-rule-fa9kgq1e90rmhc**** |
| SrcCidr |
string |
トラフィックパケットのソース CIDR ブロック。IPv4 および IPv6 アドレスがサポートされています。 |
192.168.10.0/24 |
| TrafficMatchRuleName |
string |
トラフィック分類ルールの名前。 |
nametest |
| TrafficMatchRuleStatus |
string |
トラフィック分類ルールのステータス。
|
Creating |
| AddressFamily |
string |
アドレスタイプ。有効な値: IPv4、IPv6、または空。 |
IPv4 |
| DstPortRange |
array |
トラフィック分類ルールで一致させる宛先ポートのポート範囲。 |
|
|
integer |
トラフィック分類ルールで一致させる宛先ポートのポート範囲。 この操作は 2 つの宛先ポート番号を返します。
|
80,80 |
|
| SrcPortRange |
array |
トラフィック分類ルールで一致させる送信元ポートのポート範囲。 |
|
|
integer |
トラフィック分類ルールで一致させる送信元ポートのポート範囲。 この操作は 2 つの送信元ポート番号を返します。
|
1,200 |
|
| TransitRouterId |
string |
トランジットルーターインスタンスの ID。 |
tr-ccni*** |
例
成功レスポンス
JSONJSON
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "699989E4-64A0-5F78-8B93-CDB32D98971F",
"TotalCount": 1,
"MaxResults": 20,
"TrafficMarkingPolicies": [
{
"TrafficMarkingPolicyStatus": "Creating",
"TrafficMarkingPolicyId": "tm-iz5egnyitxiroq****",
"MarkingDscp": 5,
"TrafficMarkingPolicyName": "nametest",
"Priority": 5,
"TrafficMarkingPolicyDescription": "desctest",
"TrafficMatchRules": [
{
"MatchDscp": 6,
"DstCidr": "192.168.120.0/24",
"TrafficMatchRuleDescription": "desctest",
"Protocol": "HTTP",
"TrafficMatchRuleId": "tm-rule-fa9kgq1e90rmhc****",
"SrcCidr": "192.168.10.0/24",
"TrafficMatchRuleName": "nametest",
"TrafficMatchRuleStatus": "Creating",
"AddressFamily": "IPv4",
"DstPortRange": [
0
],
"SrcPortRange": [
0
]
}
],
"TransitRouterId": "tr-ccni***"
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | MissingParam.TransitRouterIdOrTrafficMarkingPolicyId | Either TransitRouterId or TrafficMarkingPolicyId must be specified. | TransitRouterId または TrafficMarkingPolicyId パラメーターが不足しています。 |
| 400 | IllegalParam.NextToken | The specified NextToken is invalid. | リクエストで指定された NextToken が無効です。 |
| 400 | InvalidName | Name is invalid. | 名前が無効です。 |
| 400 | InvalidDescription | Description is invalid. | 説明が無効です。 |
| 400 | InvalidParameter | Invalid parameter. | パラメーターが無効です。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | アカウントにこの操作を実行する権限がありません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。