DescribeQosPolicies - 查询五元组规则 - 智能接入网关

调用DescribeQosPolicies查询QoS策略五元组规则配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
smartag:DescribeQosPolicies	Read	Qos acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	QoS 策略实例所属的地域 ID。	cn-hangzhou
QosId	string	是	QoS 策略的实例 ID。	qos-xitd8690ucu8ro****
QosPolicyId	string	否	QoS 策略五元组规则的实例 ID。	qospy-427m9fo6wkh****
Description	string	否	QoS 策略五元组规则实例的描述。长度为 1~512 个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。	docdesc
PageSize	integer	否	分页查询时每页展示的五元组规则条目数。默认值：10，最大值：50。	10
PageNumber	integer	否	分页查询时的页码。默认值：1。	1
Priority	integer	否	QoS 策略五元组规则所属的限速规则的优先级。优先级范围：1~3。数值越小，优先级越高。说明如果您已经提交工单申请并通过 CreateQosPolicy 创建了第 4 优先级的 QoS 策略，您可以通过本接口查询第 4 优先级的 QoS 策略五元组规则配置信息。	1

返回参数

名称	类型	描述	示例值
	object	QoS 策略五元组规则配置信息列表。
QosPolicies	object []	QoS 策略五元组规则配置信息列表。
DpiSignatureIds	array	应用 ID 列表。
	string	应用 ID 列表。您可以通过 ListDpiSignatures 查询应用 ID 及其对应的应用信息。	1
IpProtocol	string	QoS 策略五元组规则应用的协议类型。	TCP
QosId	string	QoS 策略的实例 ID。	qos-xitd8690ucu8ro****
Priority	integer	QoS 策略五元组规则所属的限速规则的优先级。	1
EndTime	string	QoS 策略五元组规则生效结束时间。	2019-07-14T16:41:33+0800
StartTime	string	QoS 策略五元组规则生效开始时间。	2019-07-14T16:41:33+0800
Description	string	QoS 策略五元组规则描述。	docdesc
DestCidr	string	目的网段。	10.10.10.0/24
DestPortRange	string	目的端口范围。	90/90
QosPolicyId	string	QoS 策略五元组规则的实例 ID。	qospy-427m9fo6wkh****
Name	string	QoS 策略五元组规则名称。	test
SourceCidr	string	源网段。	10.0.0.0/24
SourcePortRange	string	源端口范围。	80/80
DpiGroupIds	array	应用组 ID 列表。
	string	应用组 ID 列表。您可以通过 ListDpiGroups 查询应用组 ID 及其包含的应用信息。	20
TotalCount	integer	当前符合查询条件的 QoS 策略五元组规则条目总数。	2
PageSize	integer	分页查询时每页展示的五元组规则条目数。	10
RequestId	string	请求 ID。	97862812-2C7E-4D25-B0D5-B26DAC7FA293
PageNumber	integer	分页查询时的页码。	1

示例

正常返回示例

JSON格式

{
  "QosPolicies": {
    "QosPolicy": [
      {
        "DpiSignatureIds": {
          "DpiSignatureId": [
            "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": {
          "DpiGroupId": [
            "20"
          ]
        }
      }
    ]
  },
  "TotalCount": 2,
  "PageSize": 10,
  "RequestId": "97862812-2C7E-4D25-B0D5-B26DAC7FA293",
  "PageNumber": 1
}

错误码

HTTP status code	错误码	错误信息	描述
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.	内部服务错误。

访问错误中心查看更多错误码。