All Products
Search

This Product

    Cloud Firewall:DescribeVpcFirewallDefaultIPSConfig

    Document Center

    Cloud Firewall:DescribeVpcFirewallDefaultIPSConfig

    Last Updated:Nov 12, 2025

    Queries the intrusion prevention configuration of a specified VPC firewall.

    Operation description

    This operation queries the intrusion prevention configuration of a specified VPC firewall. Before you call this operation, you must create a VPC firewall instance.

    QPS limit

    This API operation has a limit of 10 queries per second (QPS) per user. If you exceed this limit, your calls are throttled. This may affect your business. Plan your calls accordingly.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    VpcFirewallId

    string

    Yes

    The instance ID of the VPC firewall. Valid values:

    • If the VPC firewall protects a network instance in a Cloud Enterprise Network (CEN) instance, set this parameter to the ID of the CEN instance. To query the ID of a CEN instance of Basic Edition, call the DescribeVpcFirewallCenList operation. To query the ID of a CEN instance of Enterprise Edition, call the DescribeTrFirewallsV2List operation.

    • If the VPC firewall protects traffic between two VPCs connected by an Express Connect circuit, set this parameter to the ID of the VPC firewall instance. To query the ID of the VPC firewall instance, call the DescribeVpcFirewallList operation.

    cen-****
    MemberUid

    string

    No

    The UID of the member account.

    258039427902****

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    850A84D6-****-00090125adf1
    RunMode

    integer

    The mode of the intrusion prevention system (IPS). Valid values:

    • 1: Block Mode.

    • 0: Monitor Mode.

    0
    EnableAllPatch

    integer

    Indicates whether virtual patching is enabled. Valid values:

    • 1: On.

    • 0: Off.

    1
    BasicRules

    integer

    Indicates whether basic policies are enabled. Valid values:

    • 1: On.

    • 0: Off.

    1
    RuleClass

    integer

    The IPS rule group. Valid values:

    • 1: Loose rule group.

    • 2: Medium rule group.

    • 3: Strict rule group.

    1

    Examples

    Success response

    JSON format

    {
  "RequestId": "850A84D6-****-00090125adf1",
  "RunMode": 0,
  "EnableAllPatch": 1,
  "BasicRules": 1,
  "RuleClass": 1
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorParametersUid The aliUid parameter is invalid. The aliUid parameter is invalid.
    400 ErrorVpcFirewallId The VPC firewall ID is invalid. The VPC firewall ID is invalid.
    400 ErrorDBSelect An error occurred while querying database. An error occurred while querying database.
    400 ErrorInvalidMemberUid Member uid is invalid The member is invalid.
    400 ErrorParametersFirewallId Invalid VPC firewall ID. The VPC firewall ID is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.