ListDpiConfigError API Overview - Smart Access Gateway - Alibaba Cloud - Smart Access Gateway

Queries deep packet inspection (DPI) configuration exceptions.

Operation description

If you have configured an application-based access control instance or a quality of service (QoS) policy instance and associated it with a Smart Access Gateway instance, you can invoke this operation to check whether the access control rules or 5-tuple rules of the QoS policy that you created are successfully applied to the destination Smart Access Gateway instance. If any configurations fail to be applied, this operation returns the configuration exception information.

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 supports 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 region ID of the Smart Access Gateway instance. You can invoke the DescribeRegions operation to query the regions supported by Smart Access Gateway and the corresponding region IDs.	cn-shanghai
SmartAGId	string	No	The instance ID of the Smart Access Gateway.	sag-1e8sgws6b133b8****
DpiConfigType	string	Yes	The type of the instance for which the DPI feature is configured. Valid values: acl: an access control instance. qos: a QoS policy instance. Valid values: qos : A QoS policy instance. acl : An access control instance.	qos
RuleInstanceId	string	No	The instance ID for which the DPI feature is configured.	qos-1strcafl4wghpb****
NextToken	string	No	The token used to start the next query.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The maximum number of entries allowed per page in a paged query. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token used to start the next query.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The request ID.	F47B5293-27B6-48EF-A9C6-E90A41449813
Total	integer	The total number of DPI configuration exception entries.	1
MaxResults	integer	The maximum number of entries allowed per page in a paged query.	10
DpiConfigError	array<object>	The list of DPI configuration exceptions.
	array<object>	The DPI configuration exception.
SN	string	The serial number of the Smart Access Gateway device.	sag-2160808****
SmartAGId	string	The instance ID of the Smart Access Gateway.	sag-1e8sgws6b133b8****
ErrorType	string	The type of the configuration exception. Valid values: DeviceNotSupported: The SAG device does not support the DPI feature. VersionNotSupported: The DPI version running Smart Access Gateway device is too low. NotEnable: The DPI feature is not enabled Smart Access Gateway device.	DeviceNotSupported
RuleConfigErrorList	array<object>	The list of DPI configuration exceptions.
	object	The DPI configuration exception.
DpiSignatureIds	array	The IDs of the applications that have configuration exceptions.
	string	The ID of the application that has a configuration exception. You can call the ListDpiSignatures operation to query application IDs and the corresponding application information.	1
RuleId	string	The instance IDs of the rules associated with the applications that have configuration exceptions. If you are querying the access control DPI configuration exception information, the instance ID of the access control rule instance that has a configuration exception is displayed. If you are querying the QoS policy DPI configuration exception information, the instance ID of the 5-tuple-based quintuple rules instance that has a configuration exception is displayed.	qospy-axud4s62gz632b****
DpiGroupIds	array	The IDs of the application groups that have configuration exceptions.
	string	The ID of the application group that has a configuration exception. You can call the ListDpiGroups operation to query application group IDs and the applications contained in each group.	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.