全部产品
Search
文档中心

智能接入网关:ListDpiConfigError - 查询应用识别DPI配置异常信息

更新时间:Mar 29, 2024

查询应用识别DPI(Deep Packet Inspection)配置异常的信息。

接口说明

如果您配置了基于应用的访问控制实例或 QoS 策略实例,并将其关联到了智能接入网关实例上,您可以通过调用本接口查看您创建的访问控制规则或 QoS 策略五元组规则是否都已经成功应用到了目标智能接入网关实例上。如果有未应用成功的配置,本接口会将配置异常信息返回给您。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

智能接入网关实例所属地域 ID。 您可以调用 DescribeRegions 接口查询智能接入网关支持的地域以及对应的地域 ID。

cn-shanghai
SmartAGIdstring

智能接入网关实例 ID。

sag-1e8sgws6b133b8****
DpiConfigTypestring

配置了 DPI 功能的实例类型:

  • acl:表示访问控制实例。
  • qos:表示 QoS 策略实例。
qos
RuleInstanceIdstring

配置了 DPI 功能的实例 ID。

qos-1strcafl4wghpb****
NextTokenstring

开始查询下一页的 Token。

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

分页查询时允许每页展示的配置异常的最大条目数。

取值范围:1~100

默认值:10

10

返回参数

名称类型描述示例值
object
NextTokenstring

开始查询下一页的 Token。

caeba0bbb2be03f84eb48b699f0a****
RequestIdstring

请求 ID。

F47B5293-27B6-48EF-A9C6-E90A41449813
Totalinteger

DPI 配置异常的总条目数。

1
MaxResultsinteger

分页查询时允许每页展示的配置异常的最大条目数。

10
DpiConfigErrorobject []

DPI 配置异常的信息列表。

SNstring

智能接入网关设备序列号。

sag-2160808****
SmartAGIdstring

智能接入网关实例 ID。

sag-1e8sgws6b133b8****
ErrorTypestring

配置异常类型。

  • **DeviceNotSupported **:智能接入网关设备不支持 DPI 功能。
  • **VersionNotSupported **:智能接入网关设备运行的 DPI 版本过低。
  • NotEnable:智能接入网关设备的 DPI 功能未开启。
DeviceNotSupported
RuleConfigErrorListobject []

DPI 配置异常的信息列表。

DpiSignatureIdsarray

配置异常的应用 ID 列表。

string

配置异常的应用 ID。

您可以通过 ListDpiSignatures 查询应用 ID 及其对应的应用信息。

1
RuleIdstring

配置异常的应用关联的规则 ID 列表。

  • 如果您当前查询的是访问控制 DPI 配置异常信息,则此处显示配置异常的访问控制规则实例 ID。
  • 如果您当前查询的是 QoS 策略 DPI 配置异常信息,则此处显示配置异常的五元组规则实例 ID。
qospy-axud4s62gz632b****
DpiGroupIdsarray

配置异常的应用组 ID 列表。

string

配置异常的应用组 ID。 您可以通过 ListDpiGroups 查询应用组 ID 及其包含的应用信息。

1

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "F47B5293-27B6-48EF-A9C6-E90A41449813",
  "Total": 1,
  "MaxResults": 10,
  "DpiConfigError": [
    {
      "SN": "sag-2160808****",
      "SmartAGId": "sag-1e8sgws6b133b8****",
      "ErrorType": "DeviceNotSupported",
      "RuleConfigErrorList": [
        {
          "DpiSignatureIds": [
            "1"
          ],
          "RuleId": "qospy-axud4s62gz632b****",
          "DpiGroupIds": [
            "1"
          ]
        }
      ]
    }
  ]
}

错误码

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