All Products
Search
Document Center

Cloud Firewall:DescribeVfwIPSConfigList

Last Updated:Nov 20, 2025

Queries the intrusion prevention system (IPS) configurations for VPC firewalls.

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

Lang

string

No

The language of the response.

Valid values:

  • en :

    English

  • zh :

    Chinese

zh

PageNo

integer

Yes

The number of the page to return.

1

PageSize

integer

Yes

The number of the page to return.

10

VpcFirewallId

string

No

The instance ID of the VPC firewall.

vfw-m5e7dbc4y****

Response elements

Element

Type

Description

Example

object

Schema of Response

TotalCount

integer

The total number of entries returned.

2

PageNo

integer

The page number of the returned page.

1

PageSize

integer

The number of entries on each page.

10

RequestId

string

The ID of the request.

15FCCC52-1E23-57AE-B5EF-3E00A3******

VfwIpsSwitchConfigList

array<object>

The list of configurations.

object

The list of configurations.

MemberUid

string

The UID of the member account.

134646920647****

VpcFirewallId

string

The instance ID of the VPC firewall.

cen-h678sl4wv3yd5v****

VpcFirewallName

string

The instance name of the VPC firewall.

vpc-test

RunMode

integer

The protection mode.

Valid values:

  • 0 :

    monitor mode

  • 1 :

    Block Mode

1

BasicRules

integer

The status of the basic policies.

Valid values:

  • 0 :

    disabled

  • 1 :

    enabled

1

PatchRules

integer

The status of the virtual patching policies.

Valid values:

  • 0 :

    disabled

  • 1 :

    enabled

1

RuleClass

integer

The policy for the block mode.

Valid values:

  • 1 :

    Loose

  • 2 :

    Medium

  • 3 :

    Strict

1

VpcFirewallIdList

array

The list of instance IDs of the VPC firewalls.

string

The list of instance IDs of the VPC firewalls.

vfw-9f39c248f9f447c****

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "15FCCC52-1E23-57AE-B5EF-3E00A3******",
  "VfwIpsSwitchConfigList": [
    {
      "MemberUid": "134646920647****",
      "VpcFirewallId": "cen-h678sl4wv3yd5v****",
      "VpcFirewallName": "vpc-test",
      "RunMode": 1,
      "BasicRules": 1,
      "PatchRules": 1,
      "RuleClass": 1,
      "VpcFirewallIdList": [
        "vfw-9f39c248f9f447c****"
      ]
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 ErrorDBSelect An error occurred while querying database. An error occurred while querying database.
400 ErrorParametersUid The aliUid parameter is invalid. The aliUid parameter is invalid.
400 ErrorParametersPageSizeOrNo Either pageSize or pageNo is invalid. Either pageSize or pageNo is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.