All Products
Search

This Product

    Cloud Firewall:API overview

    Document Center

    Cloud Firewall:API overview

    Last Updated:Sep 04, 2026

    API standards and multilingual preset SDKs

    The OpenAPI of this product (Cloudfw/2017-12-07) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

    Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

    Custom signature scenarios

    If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

    Account and security preparation

    Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

    Overview

    API

    Title

    Description
    DescribeUserBuyVersion Retrieve Cloud firewall instance information Retrieves the version information of a user.
    DescribeSlrGrant DescribeSlrGrant Queries the authorization information of a service-linked role (SLR) for a user.
    DescribeMemberInfo DescribeMemberInfo Describes member information.
    DescribeInstanceRiskLevels DescribeInstanceRiskLevels Queries the risk levels of instances.
    DescribeInternetOpenStatistic DescribeInternetOpenStatistic Retrieves statistics about assets exposed to the Internet.
    ModifyCfwInstance ModifyCfwInstance Updates instance information for pay-as-you-go 2.0 users.
    ReleasePostInstance ReleasePostInstance Releases a pay-as-you-go firewall.
    ReleaseExpiredInstance ReleaseExpiredInstance Releases an expired instance.
    DescribeRiskEventTopAttackAsset DescribeRiskEventTopAttackAsset Queries the top assets targeted by attacks.
    DescribeAttackAppCategory Query attack category list Queries the list of attack categories.
    DescribeOutgoingRiskTrend DescribeOutgoingRiskTrend Queries the trend of outgoing connection threats.
    DescribeUnprotectedPortTrend Query unprotected port trend Queries the trend of unprotected ports.
    DescribeVpcFirewallDropTrafficTrend DescribeVpcFirewallDropTrafficTrend Queries the blocked traffic trend for the VPC firewall.
    DescribeOutgoingRiskDomainAndIpCount DescribeOutgoingRiskDomainAndIpCount Queries the number of intrusion prevention threats.
    Traffic trends Traffic trends
    DescribeNatFirewallDropTrafficTrend Query NAT firewall interception trend on the overview page Queries the NAT firewall interception trend on the overview page.
    DescribeInternetDropTrafficTrend DescribeInternetDropTrafficTrend Internet security trends
    DescribeInvadeEcsTrend DescribeInvadeEcsTrend Queries the trend of vulnerabilities on ECS instances.
    Pay-as-you-go Pay-as-you-go
    DescribePostpayEnabledProtection DescribePostpayEnabledProtection Queries the status of pay-as-you-go protection.
    DescribePostpayTrafficTotal DescribePostpayTrafficTotal Queries the total pay-as-you-go traffic for all border firewalls.
    DescribePostpayTrafficDetail Query pay-as-you-go billing traffic details Queries the details of pay-as-you-go billing traffic.
    DescribePostpayUserInternetStatus DescribePostpayUserInternetStatus Queries the status of the Internet Border firewall for a pay-as-you-go instance.
    DescribePostpayUserNatStatus DescribePostpayUserNatStatus Queries the NAT border firewall status for a pay-as-you-go Cloud Firewall.
    DescribePostpayUserVpcStatus Query VPC firewall switch module status for a pay-as-you-go user Queries the status of the virtual private cloud (VPC) firewall switch module for a pay-as-you-go user.
    UpdatePostpayUserInternetStatus Update the Internet border firewall switch module status for a pay-as-you-go user Updates the status of the Internet Border firewall switch module for a pay-as-you-go user.
    UpdatePostpayUserNatStatus UpdatePostpayUserNatStatus Updates the status of a NAT border firewall for a pay-as-you-go instance.
    UpdatePostpayUserVpcStatus Update VPC firewall switch module status for a pay-as-you-go user Updates the status of the virtual private cloud (VPC) firewall switch module for a pay-as-you-go user.

    Firewall switches

    API

    Title

    Description
    DescribeRegionInfo Retrieve region information Retrieves region information.
    DescribeCtrlInstanceMemberAccounts DescribeCtrlInstanceMemberAccounts Queries a list of member accounts.
    DescribeFirewallTask Retrieve a firewall task Retrieves a firewall task.
    Internet border firewall Internet border firewall
    DescribeResourceTypeAutoEnable Query default traffic redirection for an asset type Queries the default traffic redirection for an asset type.
    DescribeAssetList Query information about assets protected by Cloud Firewall Queries information about assets protected by Cloud Firewall.
    DescribeAssetStatistic Retrieve asset statistics information Queries the statistics information of assets protected by Cloud Firewall.
    DescribeAssetRiskList Retrieve asset risk level list Retrieves the risk level list of assets.
    CreateInstanceSyncTask Create an internet asset synchronization task Creates a synchronization task for Internet assets.
    ModifyResourceTypeAutoEnable ModifyResourceTypeAutoEnable Modifies the automatic protection settings for new assets.
    PutEnableFwSwitch Enable a firewall switch Enables a firewall switch.
    PutEnableAllFwSwitch PutEnableAllFwSwitch Enables all firewall switches.
    PutDisableFwSwitch Disable the firewall switch Disables the firewall switch.
    PutDisableAllFwSwitch PutDisableAllFwSwitch Disables all firewall switches.
    NAT border firewall NAT border firewall
    DescribeNatFirewallQuota DescribeNatFirewallQuota Retrieves the quotas for a NAT firewall.
    DescribeNatFirewallList Query NAT firewalls Retrieves the details of NAT firewalls.
    DescribeFirewallVSwitch DescribeFirewallVSwitch Queries the vSwitches that are created by Cloud Firewall.
    DescribeNatFirewallPrecheckDetail DescribeNatFirewallPrecheckDetail Queries the precheck details for a NAT firewall.
    DescribeFirewallVswitchResources DescribeFirewallVswitchResources Queries the vSwitch resources for Cloud Firewall.
    DescribeSecurityProxyResources DescribeSecurityProxyResources Describes NAT firewall resources.
    CreateNatFirewallSyncTask Create a NAT firewall asset synchronization task Creates an asset synchronization task for a NAT firewall.
    CreateNatFirewallPreCheck Create a NAT firewall dry run Creates a dry run for a NAT firewall.
    CreateSecurityProxy Create a NAT firewall Creates a NAT firewall.
    SwitchSecurityProxy SwitchSecurityProxy Enables or disables a NAT firewall.
    UpdateSecurityProxy Update a NAT firewall Updates a NAT firewall.
    DeleteSecurityProxy Delete a NAT firewall Deletes a NAT firewall.
    VPC border firewall VPC border firewall
    DescribeVpcFirewallSummaryInfo Retrieve VPC firewall summary information Retrieves the summary information of VPC firewalls.
    DescribeVpcFirewallAccessDetail Get VPC firewall access details Retrieves the access details of a VPC firewall.
    DescribeVpcFirewallPrecheckDetail Retrieve VPC firewall precheck details Retrieves the precheck details of a VPC firewall.
    CreateVpcFirewallPrecheck CreateVpcFirewallPrecheck Creates a precheck task before you create a VPC firewall.
    CreateVpcFirewallTask CreateVpcFirewallTask Creates a sync task for VPC firewall assets.
    Cloud enterprise network (Enterprise edition) Cloud enterprise network (Enterprise edition)
    DescribeTrFirewallsV2List DescribeTrFirewallsV2List Queries the list of VPC firewalls for a transit router.
    DescribeTrFirewallsV2Detail Get TR firewall details Retrieves the details of a VPC firewall for a transit router.
    DescribeTrFirewallsV2RouteList Retrieve route table list of a VPC firewall for a transit router Retrieves the route table list of a VPC firewall for a transit router. Prerequisites: CEN → Enterprise Edition transit router → VPC connection → CreateTrFirewallV2 → routing policy.
    DescribeTrFirewallV2RoutePolicyList Retrieve routing policies for a VPC firewall for a transit router Retrieves the list of routing policies for a VPC firewall for a transit router.
    DescribeTrFirewallPolicyBackUpAssociationList DescribeTrFirewallPolicyBackUpAssociationList You can obtain an ACL backup for a VPC firewall for a transit router.
    DescribeTransitRouterResourcesList DescribeTransitRouterResourcesList Queries a list of Transit Router resources.
    CreateTrFirewallV2 Create a VPC firewall for a transit router Creates a VPC firewall for a transit router. Before you begin: (1) Purchase Cloud Firewall. (2) Create a Cloud Enterprise Network (CEN) instance and enable an Enterprise Edition forwarding router. (3) Synchronize the transit router to Cloud Firewall.
    CreateTrFirewallV2RoutePolicy Create a TR firewall routing rule Creates a routing rule for a VPC firewall for a transit router. **[Prerequisites]** Activate Cloud Firewall → Create a Cloud Enterprise Network (CEN) instance → Create an Enterprise Edition transit router → Add VPCs to the transit router route table → Call CreateTrFirewallV2 to create a VPC firewall for the transit router.
    ModifyTrFirewallV2Configuration Modify VPC firewall configuration for a transit router Modifies the configuration of a VPC firewall for a transit router. Before you call this operation, create a Cloud Enterprise Network (CEN) Enterprise Edition transit router and then call CreateTrFirewallV2 to create a VPC firewall for the transit router. You can obtain the FirewallId and then call this operation.
    ModifyFirewallV2RoutePolicySwitch ModifyFirewallV2RoutePolicySwitch Enables or disables a routing policy.
    ModifyTrFirewallV2RoutePolicyScope Modify TR firewall route policy scope Modifies the route policy scope of a VPC firewall for a transit router.
    DeleteTrFirewallV2 Delete a VPC firewall for a transit router Deletes a VPC firewall for a transit router.
    DeleteFirewallV2RoutePolicies DeleteFirewallV2RoutePolicies Deletes a routing policy for a VPC firewall for a transit router.
    Cloud enterprise network (Basic edition) Cloud enterprise network (Basic edition)
    DescribeVpcFirewallCenSummaryList DescribeVpcFirewallCenSummaryList Queries a list of Cloud Enterprise Network (CEN) instances for a VPC.
    DescribeVpcFirewallCenList DescribeVpcFirewallCenList Retrieves the details of VPC firewalls that protect traffic between a specified VPC and network instances in a Cloud Enterprise Network (CEN) instance.
    DescribeVpcFirewallCenDetail Query VPC border firewall details Queries the details of a virtual private cloud (VPC) firewall that protects traffic between network instances in a Cloud Enterprise Network (CEN) instance and a specified VPC.
    DescribeNetworkInstanceList DescribeNetworkInstanceList Queries a list of network instances.
    DescribeVpcZone DescribeVpcZone Queries the zones that are available for VPCs.
    DescribeVpcFirewallZone Query VPC firewall zones Queries the list of zones available for a VPC firewall.
    DescribeVpcFirewallManualVSwitchList Query vSwitch list in manual mode for a VPC firewall Queries the vSwitch list in manual mode for a VPC firewall.
    CreateVpcFirewallCenConfigure Create a VPC border firewall Creates a virtual private cloud (VPC) firewall to protect traffic between network instances in a Cloud Enterprise Network (CEN) instance and a specified VPC.
    ModifyVpcFirewallCenConfigure ModifyVpcFirewallCenConfigure Modifies the configuration of a VPC firewall that protects traffic between network instances in a Cloud Enterprise Network (CEN) and a specified VPC.
    ModifyVpcFirewallCenSwitchStatus ModifyVpcFirewallCenSwitchStatus Modifies the status of a VPC firewall that protects traffic between network instances in a Cloud Enterprise Network (CEN) and a specified VPC.
    DeleteVpcFirewallCenConfigure Delete a VPC border firewall (CEN) Deletes a virtual private cloud (VPC) firewall that protects mutual access traffic between a network instance in a Cloud Enterprise Network (CEN) instance and a specified VPC.
    Express connect Express connect
    DescribeVpcFirewallList DescribeVpcFirewallList Retrieves information about a VPC firewall that protects traffic between two VPCs connected by an Express Connect circuit.
    DescribeVpcFirewallDetail DescribeVpcFirewallDetail Retrieves the details of a VPC firewall that protects traffic between two VPCs connected by an Express Connect circuit.
    CreateVpcFirewallConfigure Create a VPC firewall Creates a virtual private cloud (VPC) firewall that protects traffic between two VPCs connected through Express Connect.
    ModifyVpcFirewallConfigure Modify VPC border firewall configurations Modifies the configurations of a virtual private cloud (VPC) firewall that controls traffic between two VPCs connected by using an Express Connect circuit.
    ModifyVpcFirewallSwitchStatus Modify the status of a VPC firewall Modifies the status of a virtual private cloud (VPC) firewall that protects traffic between two VPCs connected through Express Connect.
    DeleteVpcFirewallConfigure Delete a VPC firewall Deletes a virtual private cloud (VPC) firewall that protects traffic between two VPCs connected through Express Connect.

    Traffic analysis

    API

    Title

    Description
    Outbound connections Outbound connections
    Visual analysis Visual analysis
    DescribeInternetTimeTop DescribeInternetTimeTop This operation queries the Top-N internet traffic over time.
    DescribeNatFirewallTimeTop DescribeNatFirewallTimeTop Queries the top traffic data of a NAT firewall at a specific point in time.
    DescribeNetworkTrafficTopRatio DescribeNetworkTrafficTopRatio Queries the ratio of the top network traffic.
    DescribeOutgoingStatistic DescribeOutgoingStatistic Retrieves outbound connection statistics.
    DescribeOutgoingAssetList DescribeOutgoingAssetList Retrieves a list of assets with outbound connections.
    DescribeConfiguredDomainNames DescribeConfiguredDomainNames Lists the active outbound domain names.
    DescribeConfiguredDestinationIP DescribeConfiguredDestinationIP Queries outbound IPs.
    DescribeOutgoingDestinationCategory Query outbound connection destination categorizations Queries the destination categories of outbound connections.
    DescribeOutgoingTag DescribeOutgoingTag Queries outbound connection tags.
    DescribeOutgoingDomain Query outbound connection domain information Queries domain name information about outbound connections.
    DescribeOutgoingDomainDetail Retrieve outbound connection domain details Retrieves the details of an outbound domain.
    DescribeOutgoingDestination Query outbound connection destinations Queries outbound connection destinations.
    DescribeOutgoingDestinationIP DescribeOutgoingDestinationIP Displays the destination IP of an active outbound connection.
    DescribeOutgoingDestinationIPDetail DescribeOutgoingDestinationIPDetail Retrieves the details of an outbound destination IP address.
    Public network exposure Public network exposure
    DescribeInternetTrafficTop DescribeInternetTrafficTop Queries the top Internet traffic trends.
    DescribeInternetTrafficTrend DescribeInternetTrafficTrend Queries Internet traffic trends.
    DescribeNatFirewallTrafficTrend DescribeNatFirewallTrafficTrend Overview: NAT Traffic Trend
    DescribeInternetServiceNameList DescribeInternetServiceNameList Retrieves a list of Internet service names.
    DescribeInternetOpenIp Query public IP addresses of protected assets exposed to the internet Queries the details of an access control policy group in Cloud Firewall.
    DescribeInternetOpenPort DescribeInternetOpenPort Queries the ports that are open to the Internet.
    DescribeInternetOpenService DescribeInternetOpenService Queries services exposed to the Internet.
    DescribeInternetOpenDetail Obtain details about internet exposure You can obtain details about Internet access.
    DescribeInternetSlb DescribeInternetSlb Retrieves the details of Internet-facing SLB instances.
    DescribeOpenIpAccessSrcStat DescribeOpenIpAccessSrcStat Retrieves statistics about access sources for public IP addresses.
    VPC mutual access VPC mutual access
    DescribeNetworkInstanceRelationList DescribeNetworkInstanceRelationList Queries the relationships between network instances.
    DescribeVpcFirewallAssetList Query VPC firewall asset list Queries the asset list of a VPC firewall.
    AI access traffic AI access traffic
    DescribeAITrafficAnalysisStatus DescribeAITrafficAnalysisStatus Queries the enabling status of AI-powered traffic analysis.
    DescribeVpcFirewallDomainList DescribeVpcFirewallDomainList Queries a list of domain names accessed through a VPC firewall.
    DescribeVpcFirewallDomainRelationList DescribeVpcFirewallDomainRelationList Queries connections to a specified domain name through VPC Firewall.
    UpdateAITrafficAnalysisStatus UpdateAITrafficAnalysisStatus Changes the enabling status of AI-powered traffic analysis.
    ModifyObjectGroupOperation ModifyObjectGroupOperation Modifies the operation for an object group.

    Detection and response

    API

    Title

    Description
    Intrusion prevention Intrusion prevention
    DescribeRiskEventTopAttackApp DescribeRiskEventTopAttackApp Retrieves the ranking of applications that are targeted by intrusion prevention attacks.
    DescribeRiskEventTopAttackType DescribeRiskEventTopAttackType Retrieves a ranked list of attack types from intrusion prevention events.
    DescribeRiskEventStatistic DescribeRiskEventStatistic Provides statistics for intrusion prevention events.
    DescribeRiskEventPayload DescribeRiskEventPayload Queries the attack payloads of intrusion events.
    DescribeRiskEventGroup DescribeRiskEventGroup Retrieves the details of intrusion prevention events.
    Vulnerability protection Vulnerability protection
    DescribeVulnerabilityProtectedList DescribeVulnerabilityProtectedList Queries a list of vulnerabilities that Cloud Firewall can protect against.
    DescribeUnprotectedVulnTrend DescribeUnprotectedVulnTrend Queries the trend of unprotected vulnerabilities.
    Compromise awareness Compromise awareness
    DescribeInvadeEventList Query compromise awareness events in Cloud firewall Queries information about compromise awareness events in Cloud Firewall.
    DescribeInvadeEventNameList DescribeInvadeEventNameList Retrieves a list of vulnerability names.
    DescribeInvadeEventStatistic DescribeInvadeEventStatistic Queries statistics about intrusion events.
    DescribeInvadeEventDetail DescribeInvadeEventDetail Retrieves the details of a threat detection event.
    Data leakage Data leakage
    DescribeSdlEventList DescribeSdlEventList Query data breach events.
    DescribeSdlEventSdList Query sensitive data list of data leaks Retrieves the list of sensitive data involved in data leaks.
    DescribeSdlEventDetail DescribeSdlEventDetail Retrieves the details of a data leak event.
    DescribeSdlEventStatistic DescribeSdlEventStatistic Queries statistics about data leaks.
    DescribeSdlStatistic DescribeSdlStatistic Retrieves the details of sensitive data.
    DescribeSensitiveSwitch DescribeSensitiveSwitch Queries the status of the sensitive data detection switch.
    ModifySensitiveSwitch Modify sensitive data switch Modifies the sensitive data switch.
    EnableSdlProtectedAsset Enable asset data leak protection Enables data leak protection for assets. Before calling this operation, ensure that the Sensitive Data Leak (SDL) feature is activated (query DescribeUserBuyVersion.Sdl, where 1 indicates activated).
    DisableSdlProtectedAsset DisableSdlProtectedAsset Disables sensitive data discovery for a protected asset.

    Protection configuration

    API

    Title

    Description
    Access control Access control
    DescribeAclApps DescribeAclApps Queries multiple ACL applications.
    DescribeAclWhitelist Retrieve ACL whitelist Retrieves the ACL whitelist.
    Internet border Internet border
    DescribeAclRuleCount Retrieve total ACL configuration count Retrieves the total number of access control policy configurations.
    DescribeControlPolicy Retrieve all access control policy information Retrieves information about all access control policies.
    DescribeACLProtectTrend Query internet access control intercept trend Queries the trend chart of Internet access control interceptions.
    DescribePolicyAdvancedConfig DescribePolicyAdvancedConfig Queries the status of strict mode for access control policies.
    DescribePolicyPriorUsed DescribePolicyPriorUsed Queries the effective priority range of access control policies.
    DescribeControlPolicyDomainResolve Query domain name resolution results of an access control policy Queries the domain name resolution results of an access control policy.
    AddControlPolicy Add an access control policy Adds an access control policy.
    AddDomainResolveRealtimeTask Create a real-time domain name resolution task Creates a real-time domain name resolution task.
    ModifyControlPolicy Modify the configurations of an access control policy Modifies the configurations of an access control policy.
    ModifyControlPolicyPriority ModifyControlPolicyPriority Modifies the priority of an access control policy.
    ModifyPolicyAdvancedConfig ModifyPolicyAdvancedConfig Enables or disables the strict mode for access control policies.
    DeleteControlPolicy Delete an access control policy Deletes an access control policy.
    DeleteControlPolicyTemplate DeleteControlPolicyTemplate Deletes an access control policy template.
    ResetRuleHitCount ResetRuleHitCount Resets the hit count of a rule.
    NAT border NAT border
    DescribeNatAclPageStatus DescribeNatAclPageStatus Queries the paging status of the NAT firewall.
    DescribeNatFirewallAclGroupList DescribeNatFirewallAclGroupList Queries the access control policy groups for NAT firewalls.
    DescribeNatFirewallControlPolicy DescribeNatFirewallControlPolicy Queries the access control policies for NAT firewalls.
    DescribeNatFirewallPolicyPriorUsed DescribeNatFirewallPolicyPriorUsed Queries the priority range of an access control policy for a NAT firewall.
    CreateNatFirewallControlPolicy CreateNatFirewallControlPolicy Add an access control policy to a NAT firewall.
    ModifyNatFirewallControlPolicy ModifyNatFirewallControlPolicy Modify a NAT Firewall security access control policy.
    ModifyNatFirewallControlPolicyPosition Modify the priority of a NAT firewall access control policy Modifies the priority of an access control policy for a NAT firewall.
    ResetNatFirewallRuleHitCount ResetNatFirewallRuleHitCount Resets the hit count of a NAT firewall rule.
    DeleteNatFirewallControlPolicy DeleteNatFirewallControlPolicy Deletes a NAT firewall access control policy.
    DeleteNatFirewallControlPolicyBatch DeleteNatFirewallControlPolicyBatch Deletes a batch of NAT firewall policies.
    VPC border VPC border
    DescribeVpcFirewallAssetRegionList Query regions where VPC firewall is enabled for assets Queries the regions where the VPC firewall is enabled for asset protection.
    DescribeVpcFirewallAclGroupList DescribeVpcFirewallAclGroupList Queries information about all access control policy groups for VPC firewalls.
    DescribeVpcFirewallControlPolicy Query all access control policies for a specified VPC firewall Queries all access control policy information for a specified virtual private cloud (VPC) firewall.
    DescribeVpcFirewallPolicyPriorUsed DescribeVpcFirewallPolicyPriorUsed Queries the effective priority range for access control policies in a specified VPC firewall policy group.
    CreateVpcFirewallControlPolicy Add an access control policy to a specified VPC firewall policy group Adds an access control policy to a specified VPC firewall policy group.
    ModifyVpcFirewallControlPolicy ModifyVpcFirewallControlPolicy Modifies the configuration of an access control policy for a specified VPC firewall policy group.
    ModifyVpcFirewallControlPolicyPosition ModifyVpcFirewallControlPolicyPosition Modifies the priority of an access control policy in a policy group for a VPC firewall.
    ModifyVpcFirewallAclEngineMode ModifyVpcFirewallAclEngineMode Modifies the ACL engine mode for a VPC firewall.
    ResetVpcFirewallRuleHitCount ResetVpcFirewallRuleHitCount Resets the hit count of an access control policy in a specified VPC firewall policy group to zero.
    DeleteVpcFirewallControlPolicy Delete an access control policy from a VPC firewall policy group Deletes an access control policy from a specified VPC firewall policy group.
    BatchDeleteVpcFirewallControlPolicy Batch delete VPC firewall access control policies Batch deletes access control policies of a virtual private cloud (VPC) firewall.
    DNS border DNS border
    DescribeVpcListLite DescribeVpcListLite Queries a list of Virtual Private Clouds (VPCs).
    DescribeDnsFirewallPolicy DescribeDnsFirewallPolicy Queries the list of access control lists (ACLs) for the DNS firewall.
    DescribePrefixLists DescribePrefixLists Describes one or more prefix lists.
    AddDnsFirewallPolicy Add a DNS firewall ACL Adds a DNS firewall access control list (ACL).
    ModifyDnsFirewallPolicy Modify a DNS firewall rule Modifies a DNS firewall rule.
    DeleteDnsFirewallPolicy DeleteDnsFirewallPolicy Deletes a DNS firewall policy.
    IPS protection IPS protection
    DescribeThreatIntelligenceSwitch Query threat intelligence configuration information Queries the threat intelligence configuration information.
    ModifyThreatIntelligenceSwitch ModifyThreatIntelligenceSwitch Modifies the threat intelligence configuration.
    ModifyIpsRulesToDefault Reset IPS rules to default Resets IPS rules to default.
    DescribeSignatureLibVersion DescribeSignatureLibVersion Queries the version information of the signature library.
    Internet border Internet border
    DescribeDefaultIPSConfig DescribeDefaultIPSConfig Provides Intrusion Prevention System (IPS) protection for internet traffic.
    DescribeUserIPSWhitelist DescribeUserIPSWhitelist Queries the intrusion prevention system (IPS) whitelist for the Internet Border.
    ModifyIpsRules ModifyIpsRules Modifies Intrusion Prevention System (IPS) rules.
    ModifyDefaultIPSConfig Modify default IPS configuration Modifies the default IPS configuration.
    ModifyUserIPSWhitelist ModifyUserIPSWhitelist Modifies the intrusion prevention system (IPS) whitelist for the Internet Border.
    Private IP tracing Private IP tracing
    DescribeIpsPrivateAssoc DescribeIpsPrivateAssoc Queries the list of IPS Private IP Tracing associations.
    CreateIpsPrivateAssoc Create IPS private IP tracing Creates an IPS Private IP Tracing association.
    DeleteIpsPrivateAssoc DeleteIpsPrivateAssoc Creates a private network association for an IPS.
    VPC border VPC border
    DescribeVfwIPSConfigList Query VPC firewall IPS configuration list Queries the IPS configuration list of a virtual private cloud (VPC) firewall.
    DescribeVpcFirewallDefaultIPSConfig DescribeVpcFirewallDefaultIPSConfig Queries the intrusion prevention configuration of a specified VPC firewall.
    DescribeVpcFirewallIPSWhitelist Get VPC firewall IPS whitelist Retrieves the IPS whitelist of a VPC firewall.
    ModifyVpcFirewallDefaultIPSConfig ModifyVpcFirewallDefaultIPSConfig Modifies the intrusion prevention configuration of a VPC firewall.
    ModifyVpcFirewallIPSWhitelist ModifyVpcFirewallIPSWhitelist Modifies the intrusion prevention system (IPS) whitelist for a VPC firewall.
    TLS inspection TLS inspection
    ListTlsInspectCACertificates Query TLS inspection CA certificates Queries TLS inspection CA certificates.
    GetTlsInspectCertificateDownloadUrl GetTlsInspectCertificateDownloadUrl Retrieves the download path for the certificate of a Transport Layer Security (TLS) inspection policy.
    Policy analysis Policy analysis
    DescribeAclCheckQuota DescribeAclCheckQuota Queries the quota for access control list (ACL) checks.
    DescribeAclChecks DescribeAclChecks Queries Access Control List (ACL) checks in batches.
    DescribeAclCheck DescribeAclCheck Queries the details of an Access Control List (ACL) check.
    CreateAclCheck Create an ACL check Creates an ACL check.
    UpdateAclCheckDetailStatus Modify ACL Check Detail Status Modify the status of ACL check details.
    Address books Address books
    DescribeAddressBook Query address books in batches Queries address books in batches.
    AddAddressBook Create an address book Creates an address book, including IPv4 address books, ECS tag-based address books, IPv6 address books, domain name address books, and ACK address books.
    ModifyAddressBook Modify an address book Modifies an address book.
    DeleteAddressBook Delete an address book Deletes an address book.
    Synchronization nodes Synchronization nodes
    DescribeAccessInstanceRegionList Query sync node region list Queries the list of regions for sync nodes.
    DescribeAccessInstanceTask Query synchronization node task progress Queries the task progress of a synchronization node.
    DescribeAccessInstanceVpcList DescribeAccessInstanceVpcList Queries the VPCs associated with synchronization nodes.
    DescribeAccessInstanceVSwitchList DescribeAccessInstanceVSwitchList Queries the vSwitches for synchronization nodes.
    DescribeAccessInstanceZoneList DescribeAccessInstanceZoneList Returns a list of available zones for access instances.
    ACK clusters ACK clusters
    DescribeAckClusters DescribeAckClusters Queries for Container Service for Kubernetes (ACK) clusters based on specified conditions, such as cluster type and specifications.
    DescribeAckClusterConnectors Query ACK cluster connectors in batches Queries a list of ACK cluster connectors in batches.
    DescribeAckClusterConnector Query ACK cluster connector details Queries the details of a specified ACK cluster connector.
    DescribeAckClusterNamespaces DescribeAckClusterNamespaces Queries the namespaces in an Alibaba Cloud Container Service for Kubernetes (ACK) cluster.
    DescribeAckClusterPodLabels DescribeAckClusterPodLabels Queries the labels within an Alibaba Cloud Container Service for Kubernetes (ACK) cluster.
    CreateAckClusterConnector Create an ACK cluster connector Creates an ACK cluster connector.
    UpdateAckClusterConnector UpdateAckClusterConnector Updates an ACK cluster connector.
    DeleteAckClusterConnector Delete an ACK cluster connector Deletes an ACK cluster connector.
    Private DNS Private DNS
    DescribePrivateDnsEndpointList DescribePrivateDnsEndpointList Queries a list of private DNS endpoints.
    DescribePrivateDnsEndpointDetail DescribePrivateDnsEndpointDetail Retrieves the details of a private DNS endpoint.
    DescribePrivateDnsStatistics DescribePrivateDnsStatistics Returns statistics about private DNS.
    CreatePrivateDnsEndpoint Create a private DNS endpoint Creates a private DNS endpoint.
    ModifyPrivateDnsEndpoint Modify a private DNS endpoint Modifies a private DNS endpoint.
    DeletePrivateDnsEndpoint DeletePrivateDnsEndpoint Deletes a private DNS endpoint.
    DescribePrivateDnsDomainNameList Query private DNS domain names Queries the list of private DNS domain names.
    AddPrivateDnsDomainName Add a private DNS domain name Adds a private DNS domain name.
    DeletePrivateDnsDomainName DeletePrivateDnsDomainName Delete private DNS domain names
    DeletePrivateDnsAllDomainName DeletePrivateDnsAllDomainName Deletes all private DNS domain names.

    Log monitoring

    API

    Title

    Description
    DescribeLogStoreInfo Get Log Service Information Retrieves the details of the Logstore in Simple Log Service.
    DescribeTrafficLog Query log traffic information Queries log traffic information.
    DescribeSlsAnalyzeOpenStatus DescribeSlsAnalyzeOpenStatus Queries the enabled status of Log Service (SLS).
    DescribeClearAuthInfo DescribeClearAuthInfo Retrieves information about cleared authorizations.
    DescribeLocationInfo DescribeLocationInfo Retrieves information about geographic locations.
    DescribeIspInfo DescribeIspInfo Retrieves information about ISPs.
    DescribeCreatedNatFirewall DescribeCreatedNatFirewall Retrieves a list of created NAT firewalls.
    DescribeBatchSlsDispatchStatus DescribeBatchSlsDispatchStatus Queries the status of log delivery.
    CreateSlsLogDispatch Create Cloud firewall SLS log delivery Creates a log delivery configuration for Cloud Firewall to Simple Log Service (SLS).
    ModifySlsDispatchStatus ModifySlsDispatchStatus Modifies the log delivery settings for Simple Log Service (SLS).
    ModifyUserSlsLogStorageTime ModifyUserSlsLogStorageTime Modifies the retention period of user logs.
    ClearLogStoreStorage Clear firewall audit logs Clears firewall audit logs.

    System settings

    API

    Title

    Description
    Alert notifications Alert notifications
    DescribeUserAlarmConfig DescribeUserAlarmConfig Retrieves the user's alert configuration.
    ModifyUserAlarmConfig ModifyUserAlarmConfig Modifies user alert configuration.
    Multi-account management Multi-account management
    DescribeInstanceRdAccounts Retrieve instance account in a resource directory Retrieves the account in a resource directory for an instance.
    DescribeInstanceMembers DescribeInstanceMembers Retrieves information about the member accounts of Cloud Firewall.
    AddInstanceMembers Add Cloud firewall member accounts Adds member accounts to Cloud Firewall.
    ModifyInstanceMemberAttributes ModifyInstanceMemberAttributes Updates the attributes of member accounts in Cloud Firewall.
    DeleteInstanceMembers DeleteInstanceMembers Deletes Cloud Firewall member accounts.
    Download tasks Download tasks
    DescribeDownloadTask DescribeDownloadTask Queries the information and download URLs of file download tasks.
    DescribeDownloadTaskType DescribeDownloadTaskType Queries the types of download tasks. The returned types correspond to the TaskType field in other download-related API operations.
    CreateDownloadTask Create a file download task Creates a file download task.
    DeleteDownloadTask Delete a file download task Deletes a file download task.
    Toolbox Toolbox
    Policy backup and rollback Policy backup and rollback
    DescribeAclBackupList DescribeAclBackupList Queries a list of ACL backups.
    AddAclBackupData AddAclBackupData Creates an access control backup.
    UseAclBackupData UseAclBackupData Restores an access control backup.
    DeleteAclBackupData DeleteAclBackupData Deletes an ACL backup.
    DescribeSecurityMode DescribeSecurityMode Queries the settings of the safe mode.

    Deprecated

    API

    Title

    Description
    DescribePageDocuments Query page FAQ (deprecated) Queries the FAQ for a page.
    DescribeDomainResolve DescribeDomainResolve Retrieves the Domain Name System (DNS) resolution results for a domain name.
    DescribeFirewallDropStatistics DescribeFirewallDropStatistics Retrieves statistics on packets dropped by the firewall.
    DescribeUserAssetIPTrafficInfo DescribeUserAssetIPTrafficInfo Queries the traffic information for a specified asset.
    DescribeCfwRiskLevelSummary DescribeCfwRiskLevelSummary Queries a summary of threat levels for Cloud Firewall.
    DescribeRiskSecurityGroupDetail DescribeRiskSecurityGroupDetail Retrieves the details of a risk security group.
    DescribeSecurityProxy Get NAT firewall (deprecated) Retrieves NAT firewall information.
    CreateVpcFirewallCenManualConfigure CreateVpcFirewallCenManualConfigure Manually creates a VPC border firewall.
    BatchCopyVpcFirewallControlPolicy Copy all policies from a source VPC firewall policy group to a destination VPC firewall policy group (deprecated) Copies all policies from a source virtual private cloud (VPC) firewall policy group to a destination VPC firewall policy group.
    ModifyControlPolicyPosition ModifyControlPolicyPosition Modifies the priority of an IPv4 access control policy for the Internet firewall. For this type of policy, the source and destination IP addresses are in IPv4 format.

    Others

    API

    Title

    Description
    DescribeFirewallDropTrend Query firewall interception trends Retrieves the overall firewall interception trends, including Internet, VPC, and NAT traffic.
    DescribeFirewallTrafficTrend Query firewall traffic trend Queries the traffic trend of a firewall.
    DescribeIPSRules DescribeIPSRules Query IPS rules
    DescribePostpayBill Query pay-as-you-go 2.0 bills Queries pay-as-you-go 2.0 bills.
    DescribePrepayBillTotal Query subscription billing overview Queries the billing overview of a subscription 2.0 instance.
    DescribeSdlLastPayload Query sensitive data payload information Retrieves the packet payload of a sensitive data leak event.
    DescribeVpcFirewallTrafficAssetList Query assets that access domain names through a VPC firewall Queries the list of assets that access domain names through a VPC firewall.
    DescribeVpcFirewallTrafficTrend Retrieve VPC firewall traffic trend Retrieves the traffic trend of a virtual private cloud (VPC) firewall.
    SetAutoProtectNewAssets SetAutoProtectNewAssets Enables automatic protection for new assets.
    DescribeRegionResourceTypeAutoEnable Query default traffic redirection by region and asset type Queries the traffic redirection settings by region and asset type.
    DescribeTaskDispatchStatus Query log configuration modification task status Queries the execution status of a log configuration modification task.
    ModifySlsDispatchConfig Modify log delivery configurations Modifies the configurations for log delivery to Simple Log Service (SLS).