リージョン間 QoS ポリシーの作成 - Cloud Enterprise Network (CEN) - Alibaba Cloud - Cloud Enterprise Network

Enterprise Edition トランジットルーターのクロスリージョンネットワークトラフィックを最適化および制御するには、CreateCenInterRegionTrafficQosPolicy API を呼び出して、リージョン間トラフィック QoS ポリシーを作成します。

操作説明

トラフィックスケジューリングポリシーは、Enterprise Edition トランジットルーター上のリージョン間接続でのみサポートされます。
トラフィックスケジューリングポリシーは、Enterprise Edition トランジットルーターからのアウトバウンドトラフィックにのみ適用されます。

たとえば、中国 (杭州) リージョンと中国 (青島) リージョンの間にリージョン間接続があるとします。中国 (杭州) リージョンのトランジットルーターでトラフィックスケジューリングポリシーを設定した場合、トラフィックが中国 (杭州) リージョンから中国 (青島) リージョンに流れる際に、ポリシーはさまざまなサービスに必要な帯域幅を保証します。ただし、このポリシーは中国 (青島) から中国 (杭州) に流れるトラフィックには適用されません。
CreateCenInterRegionTrafficQosPolicy 操作は非同期です。リクエストを送信すると、ポリシーがバックグラウンドで作成されている間に、システムはトラフィックスケジューリングポリシー ID を返します。 ListCenInterRegionTrafficQosPolicies 操作を呼び出して、トラフィックスケジューリングポリシーの状態をクエリできます。
- ポリシーが Creating 状態の場合、クエリのみ実行できます。
- ポリシーが Active 状態の場合、正常に作成されています。

前提条件

CreateCenInterRegionTrafficQosPolicy 操作を呼び出す前に、次の前提条件が満たされていることを確認してください。

リージョン間接続が存在する必要があります。詳細については、「CreateTransitRouterPeerAttachment」をご参照ください。
トラフィックマーク付けポリシーが存在する必要があります。詳細については、「CreateTrafficMarkingPolicy」をご参照ください。

今すぐお試しください

この 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:CreateCenInterRegionTrafficQosPolicy

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するためにクライアントで生成されたトークンです。トークンはリクエスト間で一意である必要があり、最大 64 文字の ASCII 文字を含めることができます。	123e4567-e89b-12d3-a456-426655****
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true：ドライランを実行して、トラフィック QoS ポリシーを作成せずにリクエストをチェックします。システムは、必須パラメーター、正しいリクエスト構文、およびサービス制限をチェックします。リクエストがチェックに失敗した場合、システムはエラーを返します。リクエストがチェックに合格した場合、システムは `DryRunOperation` エラーコードを返します。 false (デフォルト)：通常のリクエストを送信します。リクエストがチェックに合格した場合、システムはトラフィック QoS ポリシーを作成します。	false
TransitRouterId	string	必須	トランジットルーターインスタンスの ID。	tr-8vbuqeo5h5pu3m01d****
TransitRouterAttachmentId	string	必須	リージョン間接続の ID。	tr-attach-r6g0m3epjehw57****
TrafficQosPolicyName	string	任意	トラフィック QoS ポリシーの名前。名前は空、または 1～128 文字の長さで、`http://` または `https://` で始めることはできません。	nametest
TrafficQosPolicyDescription	string	任意	トラフィック QoS ポリシーの説明。説明は空、または 1～256 文字の長さで、`http://` または `https://` で始めることはできません。	desctest
BandwidthGuaranteeMode	string	任意	帯域幅保証タイプ。 QoS キューは、絶対帯域幅値または帯域幅パーセンテージに基づいて設定できます。有効な値： byBandwidth：絶対帯域幅で QoS キューを設定します。 byBandwidthPercent (デフォルト)：帯域幅パーセンテージで QoS キューを設定します。	byBandwidthPercent
TrafficQosQueues	array<object>	任意	トラフィック QoS ポリシー内のキュー。 1 回のリクエストで最大 3 つのキューを作成できます。追加のキューを作成するには、`CreateCenInterRegionTrafficQosQueue` 操作を呼び出します。
	object	任意	キュー情報。
QosQueueName	string	任意	キューの名前。名前は空、または 1～128 文字の長さで、`http://` または `https://` で始めることはできません。	nametest
RemainBandwidthPercent	string	任意	キューが使用できるリージョン間帯域幅のパーセンテージ。たとえば、1 と入力すると、このキューで処理されるパケットは、リージョン間帯域幅の最大 1% を使用できます。説明トラフィック QoS ポリシー内のすべてのキューの帯域幅パーセンテージの合計は 100% を超えることはできません。	1
Bandwidth	string	任意	キューが使用できる最大帯域幅 (Mbps)。たとえば、1 と入力すると、このキューで処理されるパケットは、リージョン間帯域幅の最大 1 Mbps を使用できます。説明トラフィック QoS ポリシー内のすべてのキューに指定された帯域幅値の合計は、接続の合計リージョン間帯域幅を超えることはできません。	1
Dscps	array	任意	このキューが一致する DSCP 値。各キューは最大 60 個の DSCP 値に一致させることができます。
	integer	任意	キューが一致する DSCP 値。	5
QosQueueDescription	string	任意	キューの説明。説明は空、または 1～256 文字の長さで、`http://` または `https://` で始めることはできません。	desctest
ConsoleDryRun	boolean	任意

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
TrafficQosPolicyId	string	トラフィック QoS ポリシーの ID。	qos-eczzew0v1kzrb5****
RequestId	string	リクエストの ID。	6DF9A765-BCD2-5C7E-8C32-C35C8A361A39

例

成功レスポンス

JSONJSON

{
  "TrafficQosPolicyId": "qos-eczzew0v1kzrb5****",
  "RequestId": "6DF9A765-BCD2-5C7E-8C32-C35C8A361A39"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	AssociationExist.TrafficQos	The traffic qos with the specified attachment already exists.
400	InvalidTransitRouterId.NotFound	The specified TransitRouterId is not found.
400	IllegalParam.TransitRouterAttachmentId	TransitRouterAttachmentId is illegal.
400	InvalidParamSize.TrafficQosQueues	The queue size included in the traffic QoS policy exceeds the limit.
400	IllegalParam.BandwidthGuaranteeModeMismatch	The BandwidthGuaranteeMode does not match the Bandwidth or RemainBandwidthPercent.
400	IllegalParam.AttachmentBandwidthExceed	The entered bandwidth causes the total QoS guaranteed bandwidth to exceed the cross-region bandwidth allocation value.
400	IllegalParam.BandwidthGuaranteeMode	The input bandwidth guarantee type is not valid.
400	MissingParam.RemainBandwidthPercent	RemainBandwidthPercent is missing.
400	MissingParam.Bandwidth	The parameter Bandwidth is mandatory.
400	IllegalParam.RemainBandwidthPercent	The specified RemainBandwidthPercent is invalid.
400	IllegalParam.Bandwidth	Bandwidth is illegal
400	IllegalParam.BandwidthPackageStatus	The status of the bandwidth package is incorrect.
400	IncorrectStatus.TransitRouterInstance	The status of TransitRouter is incorrect.
400	IncorrectStatus.TransitRouterAttachment	TransitRouterAttachmentId status is invalid.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.
400	MissingParam.TransitRouterId	The parameter TransitrouterId is mandatory.
400	MissingParam.TransitRouterAttachmentId	The parameter TransitRouterAttachmentId is Missing.
400	Forbidden.CDTServiceExpired	The CDT service is out of service.
400	OperationUnsupported.TransitRouterType	The specified TransitRouterType does not support the operation.
400	OperationUnsupported.QosPolicyForLowLatencyLinkType	QoS Policy is not supported for Low Latency LinkType.
400	InvalidTransitRouterAttachmentId.NotFound	TransitRouterAttachmentId is not found.
400	IncorrectStatus.TransitRouterAttachmentId	The resource is not in a valid state for the attachment operation.
400	InvalidOperation.QueueLinkTypeNotEqualsAttachmentLinkType	The operation is invalid because the link type of an existing QoS queue does not match the link type of the attachment.
400	ParamMismatch.BandwidthGuaranteeModeAndQueueSchedulingMode	The parameters BandwidthGuaranteeMode and QueueSchedulingMode are incompatible.
400	InvalidOperation.NotSupportHierarchicalQoS	The operation is invalid because the transit router does not support HierarchicalQoS.
400	InvalidOperation.QueuesExceeded	The operation is invalid because the maximum queue quota for HierarchicalQoS has been exceeded.
400	ParamMismatch.QueueSchedulingModeAndBandwidth	The parameters QueueSchedulingMode and Bandwidth are incompatible.
400	IllegalParam.QueueType	The parameter QueueType is illegal.
400	ParamMismatch.QueueTypeAndBandwidthPercent	The parameters QueueType and BandwidthPercent are incompatible.
400	InvalidOperation.PriorityQueueExceeded	The operation is invalid because HierarchicalQoS supports only one priority queue.
400	ParamMismatch.QueueSchedulingModeAndQueueType	The parameters QueueSchedulingMode and QueueType are incompatible.
400	ParamMismatch.QueueSchedulingModeAndLinkType	The parameters QueueSchedulingMode and LinkType are incompatible.
400	IllegalParam.QueueSchedulingMode	The parameter QueueSchedulingMode is illegal.
400	InvalidOperation.TransitRouterNotSupportHierarchicalQoS	The operation is invalid because the transit router does not support HierarchicalQoS.

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

変更履歴

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