AddTrafficMatchRuleToTrafficMarkingPolicy - Cloud Enterprise Network - Alibaba Cloud ドキュメントセンター

トラフィック分類ルールをトラフィックマーク付けポリシーに追加します。

操作説明

AddTrafficMatchRuleToTrafficMarkingPolicy は非同期操作です。リクエストを送信すると、システムは リクエスト ID を返し、バックグラウンドでタスクを実行します。 ListTrafficMarkingPolicies 操作を呼び出して、トラフィック分類ルールのステータスをクエリできます。

トラフィック分類ルールが 作成中 状態の場合、トラフィック分類ルールは作成中です。この場合、トラフィック分類ルールをクエリすることはできますが、他の操作を実行することはできません。
トラフィック分類ルールが アクティブ 状態の場合、トラフィック分類ルールはトラフィックマーク付けポリシーに追加されます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cen:AddTrafficMatchRuleToTrafficMarkingPolicy

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを設定しない場合、ClientToken は RequestId の値に設定されます。API リクエストごとに RequestId の値が異なる場合があります。	123e4567-e89b-12d3-a456-426****
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true：ドライランを実行します。システムは必須パラメーター、リクエスト形式、および制限を確認します。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。 false（デフォルト）：ドライランを実行せずにリクエストを送信します。	false
TrafficMarkingPolicyId	string	必須	トラフィックマーク付けポリシーの ID。	tm-u9nxup5kww5po8****
TrafficMatchRules	array<object>	任意	トラフィック分類ルール。呼び出しごとに最大 50 個のトラフィック分類ルールを追加できます。
	object	任意	トラフィック分類ルールに関する情報。
MatchDscp	integer	任意	パケットの照合に使用される DSCP（Differentiated Services Code Point）値。有効な値： 0 ～ 63。指定された DSCP 値を持つパケットは一致と見なされます。DSCP 値を指定しない場合、DSCP 値に関係なくパケットは一致と見なされます。説明このパラメーターに指定する DSCP 値は、パケットがリージョン間接続を介して送信される前にパケットが持つ DSCP 値です。	5
DstCidr	string	任意	パケットの照合に使用される宛先 CIDR ブロック。宛先 IP アドレスが指定された宛先 CIDR ブロックに属するパケットは、一致と見なされます。宛先 CIDR ブロックを指定しない場合、宛先 IP アドレスに関係なく、パケットは一致と見なされます。	10.10.10.0/24
TrafficMatchRuleDescription	string	任意	トラフィック分類ルールの説明。このパラメーターはオプションです。説明を入力する場合、長さは 1 ～ 256 文字で、http:// または https:// で始めることはできません。	desctest
Protocol	string	任意	パケットの照合に使用されるプロトコル。トラフィック分類ルールは、HTTP、HTTPS、TCP、UDP、SSH、Telnet プロトコルをサポートしています。詳細については、クラウドエンタープライズネットワーク（CEN）コンソールにログインしてください。一部のプロトコルは特定のポートを使用します。クリックしてプロトコルとポートを表示します。プロトコルが ICMP の場合、宛先ポートを -1 に設定します。プロトコルが GRE の場合、宛先ポートを -1 に設定します。プロトコルが SSH の場合、宛先ポートを 22 に設定します。プロトコルが Telnet の場合、宛先ポートを 23 に設定します。プロトコルが HTTP の場合、宛先ポートを 80 に設定します。プロトコルが HTTPS の場合、宛先ポートを 443 に設定します。プロトコルが MS SQL の場合、宛先ポートを 1443 に設定します。プロトコルが Oracle の場合、宛先ポートを 1521 に設定します。プロトコルが Mysql の場合、宛先ポートを 3306 に設定します。プロトコルが RDP の場合、宛先ポートを 3389 に設定します。プロトコルが Postgre SQL の場合、宛先ポートを 5432 に設定します。プロトコルが Redis の場合、宛先ポートを 6379 に設定します。	HTTP
DstPortRange	array	任意	パケットの照合に使用される宛先ポート範囲。有効な値： -1 および 1 ～ 65535。宛先ポートが指定された宛先ポート範囲に属するパケットは、一致と見なされます。宛先ポート範囲を指定しない場合、宛先ポートに関係なく、パケットは一致と見なされます。このパラメーターには最大 2 つのポート番号を指定できます。次のルールに注意してください。 1 のようなポート番号を 1 つだけ入力すると、宛先ポートが 1 のパケットは一致と見なされます。値 -1 はすべての宛先ポートを指定します。 1 と 200 のような 2 つのポート番号を入力すると、宛先ポートが 1 と 200 の間にあるパケットは一致と見なされます。 2 つのポート番号を入力し、そのうちの 1 つが -1 の場合、もう一方のポートも -1 である必要があります。この場合、宛先ポートに関係なく、パケットは一致と見なされます。
	integer	任意	パケットの照合に使用される宛先ポート範囲。有効な値：-1 および 1 ～ 65535。宛先ポートが指定された宛先ポート範囲に属するパケットは、一致と見なされます。宛先ポート範囲を指定しない場合、宛先ポートに関係なく、パケットは一致と見なされます。最大 2 つのポート番号を入力できます。次のルールに注意してください。 1 のようなポート番号を 1 つだけ入力すると、宛先ポートが 1 のパケットは一致と見なされます。 1 と 200 のような 2 つのポート番号を入力すると、宛先ポートが 1 と 200 の間にあるパケットは一致と見なされます。 2 つのポート番号を入力し、そのうちの 1 つが -1 の場合、もう一方のポート番号も -1 である必要があります。この場合、宛先ポートに関係なく、パケットは一致と見なされます。	80
SrcCidr	string	任意	パケットの照合に使用される送信元 CIDR ブロック。送信元 IP アドレスが指定された送信元 CIDR ブロックに属するパケットは、一致と見なされます。送信元 CIDR ブロックを指定しない場合、送信元 IP アドレスに関係なく、パケットは一致と見なされます。	192.168.10.0/24
AddressFamily	string	任意	アドレスファミリ。値を IPv4 または IPv6 に設定するか、値を空のままにすることができます。	IPv4
SrcPortRange	array	任意	パケットの照合に使用される送信元ポート範囲。有効な値： -1 および 1 ～ 65535。送信元ポートが指定された送信元ポート範囲に属するパケットは、一致と見なされます。送信元ポート範囲を指定しない場合、送信元ポートに関係なく、パケットは一致と見なされます。最大 2 つのポート番号を入力できます。次のルールに注意してください。 1 のようなポート番号を 1 つだけ入力すると、送信元ポートが 1 のパケットは一致と見なされます。値 -1 はすべての送信元ポートを指定します。 1 と 200 のような 2 つのポート番号を入力すると、送信元ポートが 1 と 200 の間にあるパケットは一致と見なされます。 2 つのポート番号を入力し、そのうちの 1 つが -1 の場合、もう一方のポート番号も -1 である必要があります。この場合、送信元ポートに関係なく、パケットは一致と見なされます。
	integer	任意	パケットの照合に使用される送信元ポート範囲。有効な値： -1 および 1 ～ 65535。送信元ポートが指定された送信元ポート範囲に属するパケットは、一致と見なされます。送信元ポート範囲を指定しない場合、送信元ポートに関係なく、パケットは一致と見なされます。最大 2 つのポート番号を入力できます。次のルールに注意してください。 1 のようなポート番号を 1 つだけ入力すると、送信元ポートが 1 のパケットは一致と見なされます。 1 と 200 のような 2 つのポート番号を入力すると、送信元ポートが 1 と 200 の間にあるパケットは一致と見なされます。 2 つのポート番号を入力し、そのうちの 1 つが -1 の場合、もう一方のポート番号も -1 である必要があります。この場合、送信元ポートに関係なく、パケットは一致と見なされます。	200
TrafficMatchRuleName	string	任意	トラフィック分類ルール名。名前はオプションです。名前を入力する場合、長さは 1 ～ 128 文字で、http:// または https:// で始めることはできません。	nametest

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	レスポンス。
RequestId	string	リクエスト ID。	0876E54E-3E36-5C31-89F0-9EE8A9266F9A

例

成功レスポンス

JSONJSON

{
  "RequestId": "0876E54E-3E36-5C31-89F0-9EE8A9266F9A"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTrafficMarkingPolicyId.NotFound	Operation is failed because traffic marking policy id is not found.
400	IllegalParam.SrcCidr	The specified SrcCidr is invalid.
400	IncorrectStatus.TrafficMarkingPolicy	The status of TrafficMarkingPolicy is incorrect.
400	IllegalParam.DstCidr	The specified DstCidr is invalid.
400	IllegalParam.Protocol	The specified Protocol is invalid.
400	Duplicated.TrafficMatchRules	The parameter AddTrafficMatchRules are duplicated.
400	InstanceExist.TrafficMatchRules	The instance already exists.
400	MissingParam.TrafficMatchRules	The parameter TrafficMatchRules is empty.
400	IllegalParam.SrcPortRange	The specified SrcPortRange is illegal.
400	IllegalParam.DstPortRange	The specified DstPortRange is illegal.
400	AttrMismatching.CidrAddressFamily	Attribute SrcCidr or DstCidr of TrafficMarkRule does not match AddressFamily.
400	IllegalParam.AddressFamily	AddressFamily is illegal.
400	AttrMismatching.SrcCidrDstCidr	Attribute SrcCidr of TrafficMarkRule does not match DstCidr.
400	AttrMismatching.CidrProtocol	Attribute SrcCidr or DstCidr of TrafficMarkRule does not match Protocol.
400	InvalidTransitRouterMode.NeedUpgrade	TransitRouter need to upgrade.
400	OperationUnsupported.SrcPortRange	Current TR version does not support setting source port range.
400	OperationUnsupported.DstPortRange	Current TR version does not support setting destination port range.
400	OperationUnsupported.IPv6Cidr	The traffic marking policy for current TR type does not support IPv6 CIDR.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.
400	MissingParam.TrafficMarkingPolicyId	The parameter TrafficMarkingPolicyId is mandatory.

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

変更履歴

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