ListTrafficMarkingPolicies 操作を呼び出して、トラフィックマーク付けポリシーに関する詳細(ステータスや優先度など)をクエリできます。
操作説明
[ListTrafficMarkingPolicies] 操作を呼び出す場合:
[TransitRouterId] パラメーターと [TrafficMarkingPolicyId] パラメーターの少なくとも 1 つを指定する必要があります。
[TrafficMarkingPolicyId] パラメーターを指定しない場合、操作は [TransitRouterId]、[TrafficMarkingPolicyName]、[TrafficMarkingPolicyDescription] パラメーターに基づいて、トラフィックマーク付けポリシーに関する情報のみを返します。トラフィック分類ルールに関する情報は返されません。[TrafficMatchRules] フィールドはレスポンスに含まれません。
[TrafficMarkingPolicyId] パラメーターを指定した場合、操作はトラフィックマーク付けポリシーとそのトラフィック分類ルールに関する情報を返します。[TrafficMatchRules] フィールドはレスポンスに含まれます。[TrafficMatchRules] フィールドが空の配列の場合、ポリシーにはトラフィック分類ルールが設定されていません。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cen:ListTrafficMarkingPolicies |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
タイプ |
必須 / 任意 |
説明 |
例 |
| TransitRouterId |
string |
任意 |
TransitRouter インスタンスの 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 ~ 100 。デフォルト値: 20 。 |
20 |
| NextToken |
string |
任意 |
次のクエリに使用されるトークン。有効な値:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
レスポンスパラメーター
|
パラメーター |
タイプ |
説明 |
例 |
|
object |
レスポンス。 |
||
| NextToken |
string |
次のクエリに使用されるトークン。
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| RequestId |
string |
リクエスト ID 。 |
699989E4-64A0-5F78-8B93-CDB32D98971F |
| TotalCount |
integer |
返されたエントリの数。 |
1 |
| MaxResults |
integer |
ページごとに返されるエントリの数。 |
20 |
| TrafficMarkingPolicies |
array<object> |
トラフィックマーク付けポリシーのリスト。 |
|
|
object |
トラフィックマーク付けポリシーに関する情報。 |
||
| TrafficMarkingPolicyStatus |
string |
トラフィックマーク付けポリシーのステータス。
|
Creating |
| TrafficMarkingPolicyId |
string |
トラフィックマーク付けポリシーの ID。 |
tm-iz5egnyitxiroq**** |
| MarkingDscp |
integer |
トラフィックマーク付けポリシーの Differentiated Services Code Point ( 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 ブロック。 IPv6 アドレスと IPv4 アドレスがサポートされています。 |
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 |
TransitRouter インスタンスの 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. | |
| 400 | IllegalParam.NextToken | The specified NextToken is invalid. | |
| 400 | InvalidName | Name is invalid. | |
| 400 | InvalidDescription | Description is invalid. | |
| 400 | InvalidParameter | Invalid parameter. | |
| 400 | Unauthorized | The AccessKeyId is unauthorized. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。