All Products
Search
Document Center

Smart Access Gateway:EnableSmartAGDpiMonitor

Last Updated:Aug 28, 2026

Enables deep packet inspection (DPI) monitoring for a Smart Access Gateway (SAG) instance.

Operation description

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:EnableSmartAGDpiMonitor

update

*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.

cn-shanghai

SmartAGId

string

Yes

The ID of the SAG instance.

sag-vwmylqc9521p5l****

ClientToken

string

No

The client token that is used to ensure the idempotence of the request.

The client generates the value. It must be unique across requests, contain only ASCII characters, and not exceed 64 characters.

02fb3da4-130e-11e9****

DryRun

boolean

No

Specifies whether to precheck the request without performing the operation. Valid values:

  • true: prechecks the request without enabling DPI monitoring. Validates the request format, instance status, and required parameters. Returns an error message on failure or the request ID on success.

  • false (default): sends the request and enables DPI monitoring for the SAG instance after validation passes.

true

SlsProjectName

string

Yes

The name of the Log Service project.

test1

SlsLogStore

string

Yes

The name of the Logstore.

test2

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

64966488-B3E3-41E2-9570-4596117EC12E

Examples

Success response

JSON format

{
  "RequestId": "64966488-B3E3-41E2-9570-4596117EC12E"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidSmartAGId.NotFound The specified SmartAGId does not exist. The specified SmartAGId does not exist.
400 CreateProjectFailed Failed to create the SLS project. Failed to create the Log Service project.
400 IncorrectStatus The instance status is invalid. The instance state is invalid.
403 FeatureNotSupport The current edition of the smart access gateway does not support this feature. The current version of Smart Access Gateway does not support this feature.
403 FeatureNotSupportForActiveSmartAG The current edition of the active smart access gateway does not support this feature. The current edition of the active SAG instance does not support this feature.
403 FeatureNotSupportForStandBySmartAG The current edition of the standby smart access gateway does not support this feature. The current version of Smart Access Gateway does not support this feature.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.