ListDpiConfigError - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries configuration errors of the deep packet inspection (DPI) feature.

Operation description

Background information

If you have configured an application-aware access control list (ACL) or a quality of service (QoS) policy and associated it with a Smart Access Gateway (SAG) instance, you can call this operation to query whether the ACL rules or 5-tuples in the QoS policy are applied to the SAG instance. If settings are not applied to the SAG instance, the error information is returned.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:ListDpiConfigError	Read	SmartAccessGateway acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the SAG instance. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
SmartAGId	string	Yes	The ID of the SAG instance.	sag-1e8sgws6b133b8****
DpiConfigType	string	Yes	The type of the instance for which the DPI feature is configured. Valid values: acl qos	qos
RuleInstanceId	string	No	The ID of the instance for which the DPI feature is configured.	qos-1strcafl4wghpb****
NextToken	string	No	The token that is used to query the next page.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	The token that was used to query the next page.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The ID of the request.	F47B5293-27B6-48EF-A9C6-E90A41449813
Total	integer	The total number of entries returned.	1
MaxResults	integer	The maximum number of entries returned per page.	10
DpiConfigError	object []	The information about the configuration errors.
SN	string	The serial number of the SAG instance.	sag-2160808****
SmartAGId	string	The ID of the SAG instance.	sag-1e8sgws6b133b8****
ErrorType	string	The type of the configuration error. Valid values: DeviceNotSupported: The SAG instance does not support the DPI feature. VersionNotSupported: The version of the DPI feature is outdated. NotEnable: The DPI feature is disabled on the SAG instance.	DeviceNotSupported
RuleConfigErrorList	object []	The information about the configuration errors.
DpiSignatureIds	array	The IDs of applications that have configuration errors. You can call the ListDpiSignatures operation to query application IDs and information about the applications.
	string		1
RuleId	string	The IDs of rules that are applied to applications with configuration errors. If you make the request to query configuration errors of ACLs, the IDs of ACL rules that have configuration errors are returned. If you make the request to query configuration errors of QoS polices, the IDs of the 5-tuples in the QoS polices that have configuration errors are returned.	qospy-axud4s62gz632b****
DpiGroupIds	array	The IDs of the application groups that have configuration errors. You can call the ListDpiGroups operation to query application group IDs and information about the applications.
	string		1

Examples

Sample success responses

JSONformat

{
  "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"
          ]
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.