调用DescribeQosPolicies接口查询QoS策略五元组规则配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeQosPolicies |
系统规定参数。取值:DescribeQosPolicies。 |
RegionId | String | 是 | cn-hangzhou |
QoS策略实例所属的地域ID。 |
QosId | String | 是 | qos-xitd8690ucu8ro**** |
QoS策略的实例ID。 |
QosPolicyId | String | 否 | qospy-427m9fo6wkh**** |
QoS策略五元组规则的实例ID。 |
Description | String | 否 | docdesc |
QoS策略五元组规则实例的描述。 长度为1~512个字符,以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-)。 |
PageSize | Integer | 否 | 10 |
分页查询时每页展示的五元组规则条目数。 默认值:10,最大值:50。 |
PageNumber | Integer | 否 | 1 |
分页查询时的页码。默认值:1。 |
Priority | Integer | 否 | 1 |
QoS策略五元组规则所属的限速规则的优先级。 优先级范围:1~3。数值越小,优先级越高。 说明 如果您已经提交工单申请并通过CreateQosPolicy创建了第4优先级的QoS策略,您可以通过本接口查询第4优先级的QoS策略五元组规则配置信息。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
QosPolicies | Array of QosPolicy |
QoS策略五元组规则配置信息列表。 |
|
QosPolicy | |||
DpiSignatureIds | Array of String | 1 |
应用ID列表。 您可以通过ListDpiSignatures查询应用ID及其对应的应用信息。 |
IpProtocol | String | TCP |
QoS策略五元组规则应用的协议类型。 |
QosId | String | qos-xitd8690ucu8ro**** |
QoS策略的实例ID。 |
Priority | Integer | 1 |
QoS策略五元组规则所属的限速规则的优先级。 |
EndTime | String | 2019-07-14T16:41:33+0800 |
QoS策略五元组规则生效结束时间。 |
StartTime | String | 2019-07-14T16:41:33+0800 |
QoS策略五元组规则生效开始时间。 |
Description | String | docdesc |
QoS策略五元组规则描述。 |
DestCidr | String | 10.10.10.0/24 |
目的网段。 |
DestPortRange | String | 90/90 |
目的端口范围。 |
QosPolicyId | String | qospy-427m9fo6wkh**** |
QoS策略五元组规则的实例ID。 |
Name | String | test |
QoS策略五元组规则名称。 |
SourceCidr | String | 10.0.0.0/24 |
源网段。 |
SourcePortRange | String | 80/80 |
源端口范围。 |
DpiGroupIds | Array of String | 20 |
应用组ID列表。 您可以通过ListDpiGroups查询应用组ID及其包含的应用信息。 |
TotalCount | Integer | 2 |
当前符合查询条件的QoS策略五元组规则条目总数。 |
PageSize | Integer | 10 |
分页查询时每页展示的五元组规则条目数。 |
RequestId | String | 97862812-2C7E-4D25-B0D5-B26DAC7FA293 |
请求ID。 |
PageNumber | Integer | 1 |
分页查询时的页码。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeQosPolicies
&RegionId=cn-hangzhou
&QosId=qos-xitd8690ucu8ro****
&QosPolicyId=qospy-427m9fo6wkh****
&Description=docdesc
&PageSize=10
&PageNumber=1
&Priority=1
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeQosPoliciesResponse>
<QosPolicies>
<DpiSignatureIds>1</DpiSignatureIds>
<IpProtocol>TCP</IpProtocol>
<QosId>qos-xitd8690ucu8ro****</QosId>
<Priority>1</Priority>
<EndTime>2019-07-14T16:41:33+0800</EndTime>
<StartTime>2019-07-14T16:41:33+0800</StartTime>
<Description>docdesc</Description>
<DestCidr>10.10.10.0/24</DestCidr>
<DestPortRange>90/90</DestPortRange>
<QosPolicyId>qospy-427m9fo6wkh****</QosPolicyId>
<Name>test</Name>
<SourceCidr>10.0.0.0/24</SourceCidr>
<SourcePortRange>80/80</SourcePortRange>
<DpiGroupIds>20</DpiGroupIds>
</QosPolicies>
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<RequestId>97862812-2C7E-4D25-B0D5-B26DAC7FA293</RequestId>
<PageNumber>1</PageNumber>
</DescribeQosPoliciesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"QosPolicies" : [ {
"DpiSignatureIds" : [ "1" ],
"IpProtocol" : "TCP",
"QosId" : "qos-xitd8690ucu8ro****",
"Priority" : 1,
"EndTime" : "2019-07-14T16:41:33+0800",
"StartTime" : "2019-07-14T16:41:33+0800",
"Description" : "docdesc",
"DestCidr" : "10.10.10.0/24",
"DestPortRange" : "90/90",
"QosPolicyId" : "qospy-427m9fo6wkh****",
"Name" : "test",
"SourceCidr" : "10.0.0.0/24",
"SourcePortRange" : "80/80",
"DpiGroupIds" : [ "20" ]
} ],
"TotalCount" : 2,
"PageSize" : 10,
"RequestId" : "97862812-2C7E-4D25-B0D5-B26DAC7FA293",
"PageNumber" : 1
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidId.Qos | The specified QosId is invalid. | 您输入的参数QosId不合法。 |
403 | MissingParameter | The input parameter is missing, please check your input. | 输入参数缺失,请检查您的输入。 |
403 | InvalidParameter | The specified parameter is invalid. | 非法参数。 |
403 | InternalError | An internal server error occurred. | 内部服务错误。 |
访问错误中心查看更多错误码。