You can call this operation to query rules that contain 5-tuples in quality of service (QoS) policies.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeQosPolicies |
The operation that you want to perform. Set the value to DescribeQosPolicies. |
QosId | String | Yes | qos-jdj************ |
The ID of the QoS policy. |
RegionId | String | Yes | cn-hangzhou |
The ID of the region where the QoS policy is deployed. |
QosPolicyId | String | No | qospy-xhwhyuo43l******** |
The ID of the 5-tuple. |
Description | String | No | docdesc |
The description of the 5-tuple. |
PageSize | Integer | No | 2 |
The number of entries to return on each page. Default value: 10. Maximum value: 50. |
PageNumber | Integer | No | 2 |
The number of the page to return. Pages start from page 1. Default value: 1. |
Priority | Integer | No | 1 |
The priority of the QoS rule. A smaller value represents a higher priority. If rules have the same priority, the one applied earlier prevails. Valid values: 1 to 7. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 97862812-2C7E-4D25-B0D5-B26DAC7FA293 |
The ID of the request. |
TotalCount | Integer | 2 |
The total number of entries returned. |
PageNumber | Integer | 2 |
The page number of the returned page. Default value: 1. |
PageSize | Integer | 2 |
The number of entries returned per page. Default value: 10. Maximum value: 50. |
QosPolicies | Array |
The information about the 5-tuples. |
|
QosPolicyId | String | qospy-xhwhyuo43l******** |
The ID of the QoS rule. |
QosId | String | qos-dw**************** |
The ID of the QoS policy. |
Priority | Integer | 3 |
The priority of the QoS rule. |
Description | String | docdesc |
The description of the QoS rule. |
SourceCidr | String | 10.XX.XX.0/24 |
The source CIDR block. |
DestCidr | String | 10.XX.XX.0/12 |
The destination CIDR block. |
IpProtocol | String | TCP |
The transport layer protocol. |
SourcePortRange | String | 80/80 |
The range of source ports. |
DestPortRange | String | 80/80 |
The range of destination ports. |
StartTime | String | 2019-07-14T16:41:33+0800 |
The time when the QoS rule takes effect. |
EndTime | String | 2019-07-14T16:41:33+0800 |
The time when the QoS rule expires. |
Name | String | test |
The name of the QoS rule. The name must be 2 to 100 characters in length, and can contain digits, hyphens (-), and underscores (_). It must start with a letter or Chinese character. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeQosPolicies
&QosId=qos-jdj************
&RegionId=cn-hangzhou
&<Common request parameter>
Sample success responses
XML
format
<DescribeQosPoliciesResponse>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<QosPolicies>
<QosPolicy>
<Description>bvt-test</Description>
<DestCidr>10.XX.XX.0/24</DestCidr>
<DestPortRange>-1/-1</DestPortRange>
<IpProtocol>ALL</IpProtocol>
<Priority>1</Priority>
<QosId>qos-awfxl1adxeqyk*****</QosId>
<QosPolicyId>qospy-7h91hp3h9ykd*****</QosPolicyId>
<SourceCidr>192.168.0.0/24</SourceCidr>
<SourcePortRange>-1/-1</SourcePortRange>
</QosPolicy>
<QosPolicy>
<Description>bvt-test</Description>
<DestCidr>10.XX.XX.0/24</DestCidr>
<DestPortRange>80/80</DestPortRange>
<IpProtocol>TCP</IpProtocol>
<Priority>3</Priority>
<QosId>qos-awfxl1adxeqy*****</QosId>
<QosPolicyId>qospy-3avavlksll******</QosPolicyId>
<SourceCidr>192.168.2.0/24</SourceCidr>
<SourcePortRange>1/65535</SourcePortRange>
</QosPolicy>
</QosPolicies>
<RequestId>A6B0BBEC-3101-4A98-9805-368B04956C02</RequestId>
<TotalCount>2</TotalCount>
</DescribeQosPoliciesResponse>
JSON
format
{
"PageNumber":1,
"PageSize":10,
"QosPolicies":{
"QosPolicy":[
{
"Description":"bvt-test",
"DestCidr":"10.XX.XX.0/24",
"DestPortRange":"-1/-1",
"IpProtocol":"ALL",
"Priority":1,
"QosId":"qos-awfxl1adxeqyk*****",
"QosPolicyId":"qospy-7h91hp3h9ykd*****",
"SourceCidr":"192.168.0.0/24",
"SourcePortRange":"-1/-1"
},
{
"Description":"bvt-test",
"DestCidr":"10.XX.XX.0/24",
"DestPortRange":"80/80",
"IpProtocol":"TCP",
"Priority":3,
"QosId":"qos-awfxl1adxeqy*****",
"QosPolicyId":"qospy-3avavlksll******",
"SourceCidr":"192.168.2.0/24",
"SourcePortRange":"1/65535"
}
]
},
"RequestId":"A6B0BBEC-3101-4A98-9805-368B04956C02",
"TotalCount":2
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
403 | MissingParameter | The input parameter is missing, please check your input. | The error message returned because a required parameter is missing. Check whether you have set all required parameters. |
403 | InvalidParameter | The specified parameter is invalid. | The error message returned because a specified parameter is invalid. |
400 | InvalidId.Qos | The specified QosId is invalid. | The error message returned because the specified ID (QosId) of the QoS policy parameter is invalid. |
403 | InternalError | An internal server error occurred. | The error message returned because an internal error occurred. |
For a list of error codes, visit the API Error Center.