All Products
Search
Document Center

Smart Access Gateway:UpdateSmartAGDpiAttribute

Last Updated:Mar 03, 2024

Enables or disables the deep packet inspection (DPI) feature for a Smart Access Gateway (SAG) instance.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:UpdateSmartAGDpiAttributeWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the SAG instance is deployed.

cn-shanghai
SmartAGIdstringYes

The ID of the SAG instance.

sag-tq3sazs17smldn****
DpiEnabledbooleanYes

Specifies whether to enable the DPI feature for the SAG instance. Valid values:

  • true: enables DPI
  • false: disables DPI
true
ClientTokenstringNo

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

You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

02fb3da4-130e****
DryRunbooleanNo

Specifies whether to check the validity of the request without actually making the request. Valid values:

  • true: checks the validity of the request but does not enable or disable the DPI feature. Check items include the request format, instance status, and whether the required parameters are set. If the request fails the check, an error message is returned. If the request passes the check, the ID of the request is returned.
  • false: makes the request and enables or disables the DPI feature after the request passes the check. This is the default value.
false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

Examples

Sample success responses

JSONformat

{
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidSmartAGId.NotFoundThe specified SmartAGId does not exist.The specified SmartAGId does not exist.
403FeatureNotSupportThe current edition of the smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.
403FeatureNotSupportForActiveSmartAGThe 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.
403FeatureNotSupportForStandBySmartAGThe 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.

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