Queries traffic throttling rules of a quality of service (QoS) policy.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeQosCars |
The operation that you want to perform. Set the value to DescribeQosCars. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where the QoS policy is created. You can call the DescribeRegions operation to query the most recent region list. |
QosId | String | Yes | qos-awfxl1adxeqyk***** |
The ID of the QoS policy. |
QosCarId | String | No | qoscar-n5k8g97lihlph***** |
The ID of the traffic throttling rule. |
Order | String | No | asc |
The sorting method of the traffic throttling rules. Valid values:
By default, traffic throttling rules are sorted in the ascending order based on their priorities. |
Description | String | No | testdesc |
The description of the traffic throttling rule. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Default value: 10. |
PageNumber | Integer | No | 1 |
The number of the page to return. Default value: 1. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
TotalCount | Integer | 10 |
The total number of entries returned. |
QosCars | Array of QosCar |
The list of traffic throttling rules. |
|
QosCar | |||
MaxBandwidthAbs | Integer | 6 |
The maximum bandwidth. Unit: Mbit/s. |
PercentSourceType | String | CcnBandwidth |
The bandwidth type when traffic is throttled to a percentage of the total bandwidth of the network.
|
MinBandwidthAbs | Integer | 2 |
The minimum bandwidth. Unit: Mbit/s. |
MaxBandwidthPercent | Integer | 90 |
The maximum bandwidth percentage to which the traffic is throttled. |
Description | String | des |
The description of the traffic throttling rule. |
QosId | String | qos-dhg**** |
The ID of the QoS policy. |
LimitType | String | Absolute |
The type of traffic throttling. Valid values:
|
Priority | Integer | 3 |
The priority of the rule. |
Name | String | name |
The name of the traffic throttling rule. |
MinBandwidthPercent | Integer | 20 |
The minimum bandwidth percentage. |
QosCarId | String | qoscar-jdjg**** |
The ID of the traffic throttling rule. |
PageSize | Integer | 10 |
The number of entries returned per page. |
RequestId | String | B7B758A9-009E-4C9D-9618-714EAE8BA5E9 |
The ID of the request. |
PageNumber | Integer | 2 |
The page number of the returned page. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeQosCars
&RegionId=cn-shanghai
&QosId=qos-awfxl1adxeqyk*****
&QosCarId=qoscar-n5k8g97lihlph*****
&Order=asc
&Description=testdesc
&PageSize=10
&PageNumber=1
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeQosCarsResponse>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<QosCars>
<QosCar>
<LimitType>Absolute</LimitType>
<MaxBandwidthAbs>20</MaxBandwidthAbs>
<MinBandwidthAbs>10</MinBandwidthAbs>
<PercentSourceType>InternetUpBandwidth</PercentSourceType>
<Priority>1</Priority>
<QosCarId>qoscar-96gtdo9vwj8w*****</QosCarId>
<QosId>qos-awfxl1adxeqyk*****</QosId>
</QosCar>
<QosCar>
<LimitType>Percent</LimitType>
<MaxBandwidthPercent>20</MaxBandwidthPercent>
<MinBandwidthPercent>10</MinBandwidthPercent>
<PercentSourceType>CcnBandwidth</PercentSourceType>
<Priority>3</Priority>
<QosCarId>qoscar-ewqxo24bfc******</QosCarId>
<QosId>qos-awfxl1adxeqyk******</QosId>
</QosCar>
</QosCars>
<RequestId>B7B758A9-009E-4C9D-9618-714EAE8BA5E9</RequestId>
<TotalCount>2</TotalCount>
</DescribeQosCarsResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageNumber" : 1,
"PageSize" : 10,
"QosCars" : {
"QosCar" : [ {
"LimitType" : "Absolute",
"MaxBandwidthAbs" : 20,
"MinBandwidthAbs" : 10,
"PercentSourceType" : "InternetUpBandwidth",
"Priority" : 1,
"QosCarId" : "qoscar-96gtdo9vwj8w*****",
"QosId" : "qos-awfxl1adxeqyk*****"
}, {
"LimitType" : "Percent",
"MaxBandwidthPercent" : 20,
"MinBandwidthPercent" : 10,
"PercentSourceType" : "CcnBandwidth",
"Priority" : 3,
"QosCarId" : "qoscar-ewqxo24bfc******",
"QosId" : "qos-awfxl1adxeqyk******"
} ]
},
"RequestId" : "B7B758A9-009E-4C9D-9618-714EAE8BA5E9",
"TotalCount" : 2
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidId.Qos | The specified QosId is invalid. | The error message returned because the specified value of QosId is invalid. |
403 | MissingParameter | The input parameter is missing, please check your input. | The error message returned because one or more required parameters are not set. Check whether you have set all required parameters. |
403 | InvalidParameter | The specified parameter is invalid. | The error message returned because a parameter is set to an invalid value. |
403 | InternalError | An internal server error occurred. | The error message returned because an internal server error has occurred. |
For a list of error codes, visit the API Error Center.