CreateQosCar - Smart Access Gateway - Alibaba Cloud Documentation Center

Creates a traffic throttling rule for a quality of service (QoS) policy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:CreateQosCar	Write	Qos acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Description	string	No	The description of the traffic throttling rule.	Qosdesc
RegionId	string	Yes	The ID of the region to which the QoS policy belongs. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
QosId	string	Yes	The ID of the QoS policy.	qos-xitd8690ucu8ro****
Priority	integer	Yes	The priority of the traffic throttling rule. Valid values: 1 to 3. A smaller value indicates a higher priority. If rules have the same priority, the one created the earliest is applied.	2
LimitType	string	Yes	The type of the traffic throttling rule. Valid values: Absolute: throttles traffic based on a specific range of bandwidth values. Percent: throttles traffic based on a specific range of bandwidth percentage.	Absolute
MinBandwidthAbs	integer	Yes	The minimum bandwidth value. The value must be an integer. Unit: Mbit/s. This parameter is returned when LimitType is set to Absolute.	2
MaxBandwidthAbs	integer	Yes	The maximum bandwidth value. The value must be an integer. Unit: Mbit/s. This parameter is returned when LimitType is set to Absolute. Note The maximum bandwidth value must be greater than the minimum bandwidth value.	6
MinBandwidthPercent	integer	Yes	The minimum bandwidth percentage. Unit: percent (%). Valid values: 1 to 100. This parameter is required when you set LimitType to Percent.	20
MaxBandwidthPercent	integer	Yes	The maximum bandwidth percentage. Unit: percent (%). Valid values: 1 to 100. This parameter is required when you set LimitType to Percent. Note The maximum bandwidth percentage must be greater than the minimum bandwidth percentage.	90
PercentSourceType	string	No	The type of bandwidth when traffic is throttled based on bandwidth percentage. Valid values: CcnBandwidth: CCN bandwidth InternetUpBandwidth: total Internet bandwidth	CcnBandwidth
Name	string	No	The name of the traffic throttling rule. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.	nametest

Response parameters

Parameter	Type	Description	Example
	object
MinBandwidthAbs	integer	The minimum bandwidth value. Unit: Mbit/s. This parameter is returned when LimitType is set to Absolute.	2
Description	string	The description of the traffic throttling rule.	Qosdesc
RequestId	string	The ID of the request.	AC13E8FF-4D61-40AD-868E-817F2D3AC86A
QosCarId	string	The ID of the traffic throttling rule.	qoscar-n5k8g97lihlph****
MaxBandwidthAbs	integer	The maximum bandwidth value. Unit: Mbit/s. This parameter is returned when LimitType is set to Absolute.	6
MaxBandwidthPercent	integer	The maximum bandwidth percentage. Unit: percent (%).	90
Priority	integer	The priority value of the traffic throttling rule.	2
QosId	string	The ID of the QoS policy.	qos-xitd8690ucu8ro****
PercentSourceType	string	The type of bandwidth when traffic is throttled based on bandwidth percentage. Valid values: CcnBandwidth: CCN bandwidth InternetUpBandwidth: total Internet bandwidth	CcnBandwidth
MinBandwidthPercent	integer	The minimum bandwidth percentage. Unit: percent (%).	20
LimitType	string	The type of the traffic throttling rule. Valid values: Absolute: throttles traffic based on a specific range of bandwidth. Percent: throttles traffic based on a specific range of bandwidth percentage.	Percent

Examples

Sample success responses

JSONformat

{
  "MinBandwidthAbs": 2,
  "Description": "Qosdesc",
  "RequestId": "AC13E8FF-4D61-40AD-868E-817F2D3AC86A",
  "QosCarId": "qoscar-n5k8g97lihlph****",
  "MaxBandwidthAbs": 6,
  "MaxBandwidthPercent": 90,
  "Priority": 2,
  "QosId": "qos-xitd8690ucu8ro****",
  "PercentSourceType": "CcnBandwidth",
  "MinBandwidthPercent": 20,
  "LimitType": "Percent"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissParameter.RegionId	You must specify RegionId.	You must set the RegionId parameter.
400	MissParameter.QosId	You must specify QosId.	You must set the QosId parameter.
400	MissParameter.LimitType	You must specify LimitType.	You must specify LimitType.
400	MissParameter.Priority	You must specify Priority.	You must specify Priority.
400	InvalidParameter.LimitType	You must specify LimitType.	-
400	MissParameter.MaxBandwidthAbs	You must specify MaxBandwidthAbs.	You must specify MaxBandwidthAbs.
400	MissParameter.MaxBandwidthPercent	You must specify MaxBandwidthPercent.	You must specify MaxBandwidthPercent.
400	MissParameter.MinBandwidthAbs	You must specify MinBandwidthAbs.	You must specify MinBandwidthAbs.
400	MissParameter.MinBandwidthPercent	You must specify MinBandwidthPercent.	You must specify MinBandwidthPercent.
400	InvalidBandwidthCompare	The specified maximum bandwidth is smaller than the minimum bandwidth. Please check your input.	The specified maximum bandwidth is smaller than the minimum bandwidth. Please check your input.
400	MissParameter.PercentSourceType	You must specify PercentSourceType.	You must specify PercentSourceType.
400	InvalidId.Qos	The specified QosId is invalid.	The QosId parameter is set to an invalid value.
400	Invalid.QosCar.Priority	The specified priority of QosCarId is invalid.	The specified priority of QosCarId is invalid.
400	QosCarPerQosAmountLimit	The maximum number of QosCar in a QoS is exceeded. You can submit a ticket to increase the quota.	The maximum number of QosCar in a QoS is exceeded. Submit a ticket to increase the quota.
400	InvalidParameter.Priority	The specified Priority is invalid.	The Priority parameter is set to an invalid value.
400	InvalidParameter.PercentSourceType	The specified PercentSourceType is invalid.	The specified PercentSourceType is invalid.
400	InvalidParameter.Description	The specified Description is invalid.	The Description parameter is set to an invalid value.
400	InvalidParameter.LimitType	The specified LimitType is invalid.	The specified LimitType is invalid.
400	InvalidParameter.Name	The specified Name is invalid.	The Name parameter is set to an invalid value.
403	InternalError	An internal server error occurred.	An internal server error occurred.

For a list of error codes, visit the Service error codes.