All Products
Search
Document Center

Cloud Firewall:DescribeDefaultIPSConfig

Last Updated:Sep 02, 2024

Queries the default configurations of the intrusion prevention system (IPS).

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
yundun-cloudfirewall:DescribeDefaultIPSConfigget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the response. Valid values:

  • zh (default)
  • en
zh

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

133173B9-8010-5DF5-8B93-********
RuleClassinteger

The level of the rule group for the IPS. Valid values:

  • 1: loose
  • 2: medium
  • 3: strict
3
CtiRulesinteger

Indicates whether threat intelligence is enabled. Valid values:

  • 1: yes
  • 0: no
0
PatchRulesinteger

Indicates whether virtual patching is enabled. Valid values:

  • 1: yes
  • 0: no
0
RunModeinteger

The mode of the IPS. Valid values:

  • 1: block mode
  • 0: monitor mode
0
BasicRulesinteger

Indicates whether basic protection is enabled. Valid values:

  • 1: yes
  • 0: no
0

Examples

Sample success responses

JSONformat

{
  "RequestId": "133173B9-8010-5DF5-8B93-********",
  "RuleClass": 3,
  "CtiRules": 0,
  "PatchRules": 0,
  "RunMode": 0,
  "BasicRules": 0
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-26API Description Update. The Error code has changedView Change Details
2024-07-30The Error code has changedView Change Details