All Products
Search

This Product

    Cloud Firewall:DescribeVpcFirewallSummaryInfo

    Document Center

    Cloud Firewall:DescribeVpcFirewallSummaryInfo

    Last Updated:Aug 13, 2026

    Retrieves the summary information of VPC firewalls.

    Operation description

    QPS limit

    The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.

    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

    yundun-cloudfirewall:DescribeVpcFirewallSummaryInfo

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    The language type. Valid values:

    • zh (default): Chinese.

    • en: English.

    zh
    Lang

    string

    No

    The user type. Valid values:

    buy: paid user.

    free: free user.

    buy
    UserType

    string

    No

    The type of the user. Valid values:

    buy: Paid user

    free: Free user

    buy

    Response elements

    Element

    Type

    Description

    Example

    object

    AvailableVpcFirewallQuota

    integer

    The remaining available quota for VPC firewalls.

    4
    CenExpressConnectVpcCount

    integer

    The number of VPCs connected through Cloud Enterprise Network (CEN).

    7
    CenFirewallVpcCount

    integer

    The number of CEN VPCs.

    10
    CenTrVpcCount

    integer

    The total number of VPCs connected through CEN transit routers.

    13
    ClosedCenFirewallCount

    integer

    The number of configured but disabled CEN firewalls.

    1
    ClosedExpressConnectFirewallCount

    integer

    The number of configured but disabled Express Connect firewalls.

    10
    ClosedVpcFirewallCount

    integer

    The number of all configured but disabled VPC firewalls.

    5
    ConfiguredCenFirewallCount

    integer

    The number of configured CEN Basic Edition firewall instances.

    5
    ConfiguredCenFirewallRegionCount

    integer

    The number of configured CEN regions.

    2
    ConfiguredCenFirewallVpcCount

    integer

    The number of configured CEN VPCs.

    18
    ConfiguredCenTrFirewallCount

    integer

    The number of configured CEN transit router firewall instances.

    2
    ConfiguredExpressConnectFirewallCount

    integer

    The number of configured Express Connect circuits.

    2
    ConfiguredExpressConnectVpcCount

    integer

    The number of configured Express Connect VPCs.

    2
    ConfiguredVpcFirewallCount

    integer

    The number of all configured VPC firewalls.

    5
    ConfiguredVpcFirewallVpcCount

    integer

    The number of VPCs with firewalls configured.

    1
    ExpressConnectVpcCount

    integer

    The number of Express Connect VPCs.

    2
    NotConfiguredCenFirewallCount

    integer

    The number of unconfigured CEN firewalls.

    0
    NotConfiguredCenTrFirewallCount

    integer

    The number of unconfigured CEN transit router firewall instances.

    6
    NotConfiguredExpressConnectFirewallCount

    integer

    The number of unconfigured Express Connect firewalls.

    7
    NotConfiguredVpcFirewallCount

    integer

    The number of all unconfigured VPC firewalls.

    12
    OpenedCenExpressConnectVpcCount

    integer

    The number of enabled and active VPC connections.

    10
    OpenedCenFirewallCount

    integer

    The number of enabled CEN firewalls.

    4
    OpenedCenFirewallVpcCount

    integer

    The number of VPCs protected by CEN firewalls.

    0
    OpenedCenTrFirewallVpcCount

    integer

    The number of VPCs protected by CEN transit router firewalls.

    4
    OpenedEcrCount

    integer

    The number of CEN Express Connect Router (ECR) instances.

    0
    OpenedExpressConnectFirewallCount

    integer

    The number of enabled Express Connect firewalls.

    15
    OpenedExpressConnectVpcCount

    integer

    The number of VPCs protected by Express Connect firewalls.

    2
    OpenedPeerTrCount

    integer

    The number of protected inter-region connections through CEN transit routers.

    3
    OpenedVbrCount

    integer

    The total number of protected Virtual Border Routers (VBRs) through CEN transit routers.

    0
    OpenedVpcCount

    integer

    The total number of protected VPCs.

    17
    OpenedVpcFirewallCount

    integer

    The number of all enabled VPC firewalls.

    9
    OpenedVpnCount

    integer

    The total number of protected VPN connections through CEN transit routers.

    6
    RequestId

    string

    The request ID.

    8AABEF64-7ABF-52CB-BA6C-0598E3DB****
    TotalEcrCount

    integer

    The total number of ECR instances.

    2
    TotalPeerTrCount

    integer

    The total number of inter-region connections through CEN transit routers.

    6
    TotalVbrCount

    integer

    The total number of VBRs through CEN transit routers.

    5
    TotalVpcCount

    integer

    The total number of interconnected VPCs.

    2
    TotalVpcFirewallQuota

    integer

    The total VPC firewall quota.

    5
    TotalVpnCount

    integer

    The total number of VPN connections through CEN transit routers.

    1

    Examples

    Success response

    JSON format

    {
  "AvailableVpcFirewallQuota": 4,
  "CenExpressConnectVpcCount": 7,
  "CenFirewallVpcCount": 10,
  "CenTrVpcCount": 13,
  "ClosedCenFirewallCount": 1,
  "ClosedExpressConnectFirewallCount": 10,
  "ClosedVpcFirewallCount": 5,
  "ConfiguredCenFirewallCount": 5,
  "ConfiguredCenFirewallRegionCount": 2,
  "ConfiguredCenFirewallVpcCount": 18,
  "ConfiguredCenTrFirewallCount": 2,
  "ConfiguredExpressConnectFirewallCount": 2,
  "ConfiguredExpressConnectVpcCount": 2,
  "ConfiguredVpcFirewallCount": 5,
  "ConfiguredVpcFirewallVpcCount": 1,
  "ExpressConnectVpcCount": 2,
  "NotConfiguredCenFirewallCount": 0,
  "NotConfiguredCenTrFirewallCount": 6,
  "NotConfiguredExpressConnectFirewallCount": 7,
  "NotConfiguredVpcFirewallCount": 12,
  "OpenedCenExpressConnectVpcCount": 10,
  "OpenedCenFirewallCount": 4,
  "OpenedCenFirewallVpcCount": 0,
  "OpenedCenTrFirewallVpcCount": 4,
  "OpenedEcrCount": 0,
  "OpenedExpressConnectFirewallCount": 15,
  "OpenedExpressConnectVpcCount": 2,
  "OpenedPeerTrCount": 3,
  "OpenedVbrCount": 0,
  "OpenedVpcCount": 17,
  "OpenedVpcFirewallCount": 9,
  "OpenedVpnCount": 6,
  "RequestId": "8AABEF64-7ABF-52CB-BA6C-0598E3DB****",
  "TotalEcrCount": 2,
  "TotalPeerTrCount": 6,
  "TotalVbrCount": 5,
  "TotalVpcCount": 2,
  "TotalVpcFirewallQuota": 5,
  "TotalVpnCount": 1
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
    400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
    400 ErrorUserCredentials User credentials failed. Unauthorized, not accessible, please first authorize firewall permissions.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.