DocsICP FilingConsole
Documentation

CreateCenInterRegionTrafficQosPolicy

Updated at:
Copy as MD
Product
My Favorites

To optimize and control cross-region network traffic for a Transit Router (Enterprise Edition), call the CreateCenInterRegionTrafficQosPolicy API to create an inter-region traffic QoS policy.

Operation description

  • Traffic scheduling policies are supported only for inter-region connections on an Enterprise Edition transit router.

  • Traffic scheduling policies apply only to outbound traffic from an Enterprise Edition transit router.

    For example, you have an inter-region connection between the China (Hangzhou) and China (Qingdao) regions. If you configure a traffic scheduling policy on the transit router in the China (Hangzhou) region, the policy guarantees the required bandwidth for various services when traffic flows from the China (Hangzhou) region to the China (Qingdao) region. However, the policy does not apply to traffic flowing from China (Qingdao) to China (Hangzhou).

  • The CreateCenInterRegionTrafficQosPolicy operation is asynchronous. After you send a request, the system returns a traffic scheduling policy ID while the policy is created in the background. You can call the ListCenInterRegionTrafficQosPolicies operation to query the status of the traffic scheduling policy.

    • If a policy is in the Creating state, you can only query it.

    • If a policy is in the Active state, it has been successfully created.

Prerequisites

Before you call the CreateCenInterRegionTrafficQosPolicy operation, ensure the following prerequisites are met:

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:CreateCenInterRegionTrafficQosPolicy

create

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
ClientToken

string

No

A client-generated token that ensures the idempotence of the request.

The token must be unique across requests and can contain up to 64 ASCII characters.

123e4567-e89b-12d3-a456-426655****
DryRun

boolean

No

Specifies whether to perform a dry run. Valid values:

  • true: Performs a dry run to check the request without creating the traffic QoS policy. The system checks for required parameters, correct request syntax, and service limits. If the request fails the check, the system returns an error. If the request passes the check, the system returns the DryRunOperation error code.

  • false (default): Sends a normal request. The system creates the traffic QoS policy if the request passes the check.

false
TransitRouterId

string

Yes

The ID of the Transit Router instance.

tr-8vbuqeo5h5pu3m01d****
TransitRouterAttachmentId

string

Yes

The ID of the inter-region connection.

tr-attach-r6g0m3epjehw57****
TrafficQosPolicyName

string

No

The name of the traffic QoS policy.

The name can be empty or 1 to 128 characters long, and cannot start with http:// or https://.

nametest
TrafficQosPolicyDescription

string

No

The description of the traffic QoS policy.

The description can be empty or 1 to 256 characters long, and cannot start with http:// or https://.

desctest
BandwidthGuaranteeMode

string

No

The bandwidth guarantee type. You can configure QoS queues based on an absolute bandwidth value or a bandwidth percentage. Valid values:

  • byBandwidth: Configures QoS queues by absolute bandwidth.

  • byBandwidthPercent (default): Configures QoS queues by bandwidth percentage.

byBandwidthPercent
TrafficQosQueues

array<object>

No

The queues in the traffic QoS policy.

You can create up to three queues in a single request. To create additional queues, call the CreateCenInterRegionTrafficQosQueue operation.

object

No

The queue information.

QosQueueName

string

No

The name of the queue.

The name can be empty or 1 to 128 characters long, and cannot start with http:// or https://.

nametest
RemainBandwidthPercent

string

No

The percentage of inter-region bandwidth that the queue can use.

For example, if you enter 1, packets processed by this queue can use a maximum of 1% of the inter-region bandwidth.

Note

The sum of the bandwidth percentages of all queues in a traffic QoS policy cannot exceed 100%.

1
Bandwidth

string

No

The maximum bandwidth that the queue can use, in Mbps.

For example, if you enter 1, packets processed by this queue can use a maximum of 1 Mbps of the inter-region bandwidth.

Note

The sum of the bandwidth values specified for all queues in a traffic QoS policy cannot exceed the total inter-region bandwidth of the connection.

1
Dscps

array

No

The DSCP values that this queue matches.

Each queue can match up to 60 DSCP values.

integer

No

A DSCP value that the queue matches.

5
QosQueueDescription

string

No

The description of the queue.

The description can be empty or 1 to 256 characters long, and cannot start with http:// or https://.

desctest
ConsoleDryRun

boolean

No

Response elements

Element

Type

Description

Example

object

The response data.

TrafficQosPolicyId

string

The ID of the traffic QoS policy.

qos-eczzew0v1kzrb5****
RequestId

string

The ID of the request.

6DF9A765-BCD2-5C7E-8C32-C35C8A361A39

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description
400 AssociationExist.TrafficQos The traffic qos with the specified attachment already exists. The error message returned because the specified attachment is already associated with a QoS policy.
400 InvalidTransitRouterId.NotFound The specified TransitRouterId is not found. The error message returned because the specified transit router does not exist.
400 IllegalParam.TransitRouterAttachmentId TransitRouterAttachmentId is illegal. The error message returned because the specified transit router is invalid.
400 InvalidParamSize.TrafficQosQueues The queue size included in the traffic QoS policy exceeds the limit. The queue size included in the traffic scheduling policy exceeds the limit.
400 IllegalParam.BandwidthGuaranteeModeMismatch The BandwidthGuaranteeMode does not match the Bandwidth or RemainBandwidthPercent. 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. 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. The input bandwidth guarantee type is not valid.
400 MissingParam.RemainBandwidthPercent RemainBandwidthPercent is missing. RemainBandwidthPercent is missing.
400 MissingParam.Bandwidth The parameter Bandwidth is mandatory. The error message returned because no bandwidth value is specified. You must specify a bandwidth value.
400 IllegalParam.RemainBandwidthPercent The specified RemainBandwidthPercent is invalid. The error message returned because the RemainBandwidthPercent parameter is set to invalid value.
400 IllegalParam.Bandwidth Bandwidth is illegal The error message returned because the specified bandwidth value is invalid.
400 IllegalParam.BandwidthPackageStatus The status of the bandwidth package is incorrect. The status of the bandwidth package is incorrect.
400 IncorrectStatus.TransitRouterInstance The status of TransitRouter is incorrect. The error message returned because the transit router is in an invalid state.
400 IncorrectStatus.TransitRouterAttachment TransitRouterAttachmentId status is invalid. The error message returned because the status of the transit router attachment does not support this operation. Try again later.
400 InvalidParameter Invalid parameter. The error message returned because the parameter is set to an invalid value.
400 Unauthorized The AccessKeyId is unauthorized. The error message returned because you do not have the permissions to perform this operation.
400 MissingParam.TransitRouterId The parameter TransitrouterId is mandatory. The error message returned because the TransitRouterId parameter is not set.
400 MissingParam.TransitRouterAttachmentId The parameter TransitRouterAttachmentId is Missing. The error message returned because the TransitRouterAttachmentId parameter is not set.
400 Forbidden.CDTServiceExpired The CDT service is out of service. The cloud data transfer service has been suspended due for payment. Please renew the service and try again.
400 OperationUnsupported.TransitRouterType The specified TransitRouterType does not support the operation. The error message returned because this operation is not supported by the specified type of transit router.
400 OperationUnsupported.QosPolicyForLowLatencyLinkType QoS Policy is not supported for Low Latency LinkType. QoS Policy is not supported for Low Latency LinkType.
400 InvalidTransitRouterAttachmentId.NotFound TransitRouterAttachmentId is not found. The error message returned because the ID of the network instance does not exist.
400 IncorrectStatus.TransitRouterAttachmentId The resource is not in a valid state for the attachment operation. The error message returned because the operation is not supported when the specified attachment is in an unstable state
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. 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. The parameters BandwidthGuaranteeMode and QueueSchedulingMode are incompatible.
400 InvalidOperation.NotSupportHierarchicalQoS The operation is invalid because the transit router does not support HierarchicalQoS. 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. The operation is invalid because the maximum queue quota for HierarchicalQoS has been exceeded.
400 ParamMismatch.QueueSchedulingModeAndBandwidth The parameters QueueSchedulingMode and Bandwidth are incompatible. The parameters QueueSchedulingMode and Bandwidth are incompatible.
400 IllegalParam.QueueType The parameter QueueType is illegal. The parameter QueueType is illegal.
400 ParamMismatch.QueueTypeAndBandwidthPercent The parameters QueueType and BandwidthPercent are incompatible. The parameters QueueType and BandwidthPercent are incompatible.
400 InvalidOperation.PriorityQueueExceeded The operation is invalid because HierarchicalQoS supports only one priority queue. The operation is invalid because HierarchicalQoS supports only one priority queue.
400 ParamMismatch.QueueSchedulingModeAndQueueType The parameters QueueSchedulingMode and QueueType are incompatible. The parameters QueueSchedulingMode and QueueType are incompatible.
400 ParamMismatch.QueueSchedulingModeAndLinkType The parameters QueueSchedulingMode and LinkType are incompatible. The parameters QueueSchedulingMode and LinkType are incompatible.
400 IllegalParam.QueueSchedulingMode The parameter QueueSchedulingMode is illegal. The parameter QueueSchedulingMode is illegal.
400 InvalidOperation.TransitRouterNotSupportHierarchicalQoS The operation is invalid because the transit router does not support HierarchicalQoS. The operation is invalid because the transit router does not support HierarchicalQoS.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.