DescribeQosCars - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries traffic throttling rules of 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:DescribeQosCars	Read	Qos acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the QoS policy is created. 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-awfxl1adxeqyk****
QosCarId	string	No	The ID of the traffic throttling rule.	qoscar-n5k8g97lihlph****
Order	string	No	The sorting method of the traffic throttling rules. Valid values: asc: sorted in ascending order. This is the default value. desc: sorted in descending order. By default, traffic throttling rules are sorted in ascending order of priority.	asc
Description	string	No	The description of the traffic throttling rule.	testdesc
PageSize	integer	No	The number of entries to return per page. Valid values: 1 to 50. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	10
QosCars	object []	The list of traffic throttling rules.
MaxBandwidthAbs	integer	The maximum bandwidth. Unit: Mbit/s.	6
PercentSourceType	string	The bandwidth type when traffic is throttled based on bandwidth percentage. CcnBandwidth: Cloud Connect Network (CCN) bandwidth. InternetUpBandwidth: Internet upstream bandwidth.	CcnBandwidth
MinBandwidthAbs	integer	The minimum bandwidth. Unit: Mbit/s.	2
MaxBandwidthPercent	integer	The maximum bandwidth percentage.	90
Description	string	The description of the traffic throttling rule.	des
QosId	string	The ID of the QoS policy.	qos-awfxl1adxeqyk****
LimitType	string	The type of traffic throttling. Valid values: Absolute: throttles traffic based on a specific range of bandwidth. Percent: throttles traffic based on a specific range of bandwidth percentage.	Absolute
Priority	integer	The priority of the rule.	3
Name	string	The name of the traffic throttling rule.	name
MinBandwidthPercent	integer	The minimum bandwidth percentage.	20
QosCarId	string	The ID of the traffic throttling rule.	qos-awfxl1adxeqyk****
PageSize	integer	The number of entries returned on each page.	10
RequestId	string	The ID of the request.	B7B758A9-009E-4C9D-9618-714EAE8BA5E9
PageNumber	integer	The number of the returned page.	1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "QosCars": {
    "QosCar": [
      {
        "MaxBandwidthAbs": 6,
        "PercentSourceType": "CcnBandwidth",
        "MinBandwidthAbs": 2,
        "MaxBandwidthPercent": 90,
        "Description": "des",
        "QosId": "qos-awfxl1adxeqyk****",
        "LimitType": " Absolute",
        "Priority": 3,
        "Name": "name",
        "MinBandwidthPercent": 20,
        "QosCarId": "qos-awfxl1adxeqyk****"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "B7B758A9-009E-4C9D-9618-714EAE8BA5E9",
  "PageNumber": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidId.Qos	The specified QosId is invalid.	The QosId parameter is set to an invalid value.
403	MissingParameter	The input parameter is missing, please check your input.	Missing parameters. Check whether all required parameters are set.
403	InvalidParameter	The specified parameter is invalid.	Invalid parameters.
403	InternalError	An internal server error occurred.	An internal server error occurred.

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