Prioritize Traffic with Express Connect QoS Queues via API - Express Connect - Alibaba Cloud - Express Connect

Operation description

The default queue cannot be created.
The number of high-priority queues has an upper limit. To increase the quota, contact your account manager.
The number of lower-priority queues has an upper limit. To increase the quota, contact your account manager.
The total bandwidth percentage of all lower-priority queues has an upper limit.

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

vpc:CreateExpressConnectTrafficQosQueue

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the QoS policy. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe637760
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe637760
QueueName	string	No	The name of the QoS queue. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	qos-queue-test
QueueDescription	string	No	The description of the QoS queue. The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	qos-queue-test
QosId	string	Yes	The ID of the QoS policy.	qos-2giu0a6vd5x0mv****
QueueType	string	Yes	The type of the QoS queue. Valid values: High: high-priority queue. Medium: lower-priority queue. Default: default priority queue. Note The default priority queue cannot be created.	High
BandwidthPercent	string	No	The bandwidth percentage of the QoS queue. When the QoS queue type is Medium, this parameter is required. Valid values: 1 to 100. When the QoS queue type is Default, this parameter is set to "-".	100

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4CF20CC7-D1FC-425B-A15B-DF7C8E2131A7
QosId	string	The ID of the QoS policy.	qos-2giu0a6vd5x0mv****
QueueId	string	The ID of the QoS queue.	qos-queue-9nyx2u7n71s2rc****

Examples

Success response

JSON format

{
  "RequestId": "4CF20CC7-D1FC-425B-A15B-DF7C8E2131A7",
  "QosId": "qos-2giu0a6vd5x0mv****",
  "QueueId": "qos-queue-9nyx2u7n71s2rc****\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.%s	The param of %s is illegal.	The parameter is invalid.
400	QuotaExceeded.QosMediumPriorityQueueCount	The quota of QosMediumPriorityQueueCount is exceeded.	The number of normal priority queues in the QoS policy exceeds the specification. If you need to increase the quota, contact the business manager.
400	QuotaExceeded.QosHighPriorityQueueCount	The quota of QosHighPriorityQueueCount is exceeded.	The number of high-priority queues in the QoS policy exceeds the specification. If you need to increase the quota, contact the business manager.
400	QuotaExceeded.QosMediumPriorityQueueBandwidthPercent	The quota of QosMediumPriorityQueueBandwidthPercent is exceeded.	The sum of the bandwidth percentages of the normal priority queues in the QoS policy exceeds the specification.
400	IncorrectStatus.Qos	The status of QoS is incorrect.	The status of the QoS policy is abnormal and the operation cannot be performed. Try again later.
400	EcQoSConflict	The specified QoS is conflict with other QoS.	The current QoS configuration conflicts with other configurations. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.