ListDpiConfigError - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries for deep packet inspection (DPI) configuration errors.

Operation description

If you configure an application-based Resource Access Management instance or a Quality of Service (QoS) policy instance and associate it with a Smart Access Gateway instance, you can call this operation to check whether the access control rules or QoS quintuple rules are successfully applied to the target Smart Access Gateway instance. If a configuration fails to apply, this operation returns information about the error.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:ListDpiConfigError

get

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Smart Access Gateway instance is deployed. You can call the DescribeRegions operation to query the regions and their IDs that Smart Access Gateway supports.	cn-shanghai
SmartAGId	string	No	The ID of the Smart Access Gateway instance.	sag-1e8sgws6b133b8****
DpiConfigType	string	Yes	The type of instance for which the DPI feature is configured: acl: a Resource Access Management instance. qos: a QoS policy instance.	qos
RuleInstanceId	string	No	The ID of the instance for which the DPI feature is configured.	qos-1strcafl4wghpb****
NextToken	string	No	The token for the next page of results.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The maximum number of configuration errors 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 for the next page of results.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The request ID.	F47B5293-27B6-48EF-A9C6-E90A41449813
Total	integer	The total number of DPI configuration errors.	1
MaxResults	integer	The maximum number of configuration errors to return on each page.	10
DpiConfigError	array<object>	A list of DPI configuration errors.
	object	The information about a DPI configuration error.
SN	string	The serial number of the Smart Access Gateway device.	sag-2160808****
SmartAGId	string	The ID of the Smart Access Gateway instance.	sag-1e8sgws6b133b8****
ErrorType	string	The type of the configuration error. DeviceNotSupported: The Smart Access Gateway device does not support the DPI feature. VersionNotSupported: The DPI version of the Smart Access Gateway device is too old. NotEnable: The DPI feature is disabled for the Smart Access Gateway device.	DeviceNotSupported
RuleConfigErrorList	array<object>	A list of rule configuration errors.
	object	The information about a rule configuration error.
DpiSignatureIds	array	A list of IDs of applications that have configuration errors.
	string	The ID of the application that has a configuration error. You can call the ListDpiSignatures operation to query application IDs and information about the applications.	1
RuleId	string	The ID of the rule that is associated with the application that has a configuration error. If you query DPI configuration errors for Resource Access Management, this parameter indicates the ID of the Resource Access Management rule instance that has a configuration error. If you query DPI configuration errors for a QoS policy, this parameter indicates the ID of the quintuple rule instance that has a configuration error.	qospy-axud4s62gz632b****
DpiGroupIds	array	A list of IDs of application groups that have configuration errors.
	string	The ID of the application group that has a configuration error. You can call the ListDpiGroups operation to query application group IDs and the applications that are included in the application groups.	1

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.