Shape Dedicated Circuit Traffic with Express Connect QoS API - Express Connect - Alibaba Cloud - Express Connect

Calls the ModifyExpressConnectTrafficQos operation to modify an Express Connect Quality of Service (QoS) policy. You can also use this operation to associate dedicated Express Connect circuits.

Operation description

Only dedicated Express Connect circuits that are in the Normal state and do not have overdue payments can be associated. Shared Express Connect circuit ports and Virtual Border Router (VBR) instances are not supported.
When associating dedicated Express Connect circuits, only full operations are supported. To dissociate all circuits, pass an empty string.
If a dedicated Express Connect circuit has shared Express Connect circuits or cross-account VBRs, you must activate the whitelist feature before association.
The device on which the dedicated Express Connect circuit resides must support the QoS feature before association.
In scenarios where a single VBR is associated with multiple Express Connect circuits, you must associate all Express Connect circuits of the VBR at the same time.

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:ModifyExpressConnectTrafficQos

update

*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
QosName	string	No	The name of the QoS policy. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	qos-test
QosDescription	string	No	The description of the QoS policy. The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	qos-test
QosId	string	Yes	The ID of the QoS policy.	qos-2giu0a6vd5x0mv****
AddInstanceList	array<object>	No	The list of instances to add in this update. You do not need to specify this parameter if no instances need to be added.
	object	No
InstanceId	string	No	The instance ID to associate.	pc-bp159zj8zujwy3p07****
InstanceType	string	No	The type of the instance to associate. Valid values: PHYSICALCONNECTION: Express Connect circuit.	PHYSICALCONNECTION
RemoveInstanceList	array<object>	No	The list of instances to remove in this update. You do not need to specify this parameter if no instances need to be removed.
	object	No
InstanceId	string	No	The instance ID of the associated instance.	pc-bp1j37am632492qzw****
InstanceType	string	No	The type of the associated instance. Valid values: PHYSICALCONNECTION: Express Connect circuit.	PHYSICALCONNECTION

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B457

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.%s	The param of %s is illegal.	The parameter is invalid.
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	IncorrectStatus.PconnIdList	The status of PconnIdList is incorrect.	This operation cannot be performed because the current physical connection is in an abnormal state.
400	ResourceAlreadyAssociated.PconnQos	The specified resource of PconnQos is already associated.	The physical line has been bound to another QoS policy.
400	EcQoSConflict	The specified QoS is conflict with other QoS.	The current QoS configuration conflicts with other configurations. Please try again later.
400	IncorrectBusinessStatus.PconnIdList	The business status of PconnIdList is incorrect.	This operation cannot be performed because the current physical line is in arrears.
400	EcPconnWithVpconnNotAllowAssociateQoS	The specified Pconn with Vpconn is not allowed to associate with Qos.	Exclusive physical lines that contain shared physical lines cannot be bound to QoS policies.
400	EcPconnWithCrossAccountVbrNotAllowAssociateQoS	The specified Pconn with cross account VBR is not allowed to associate with Qos.	Exclusive physical connections that contain cross-account virtual border routers cannot bind QoS policies.
400	EcDeviceNotSupportQoS	The specified Pconn is on the device which is not supported QoS.	The device where the physical connection is located does not support the QoS feature.
400	EcPconnVbrMustContainsAll	In the single VBR with multiple Pconn scene, all Pconn must be associated with the same Qos.	In a single VBR and multiple Pconn scenarios, all Pconn must be bound to a QoS policy.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.