API overview

更新时间:
复制 MD 格式

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 DescribeUserBuyVersion Retrieves version information for 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 Trend Traffic Trend
DescribeNatFirewallDropTrafficTrend DescribeNatFirewallDropTrafficTrend Overview - NAT firewall blocking trends
DescribeInternetDropTrafficTrend DescribeInternetDropTrafficTrend Internet security trends
DescribeInvadeEcsTrend DescribeInvadeEcsTrend Queries the trend of vulnerabilities on ECS instances.
Pay by volume Pay by volume
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 UpdatePostpayUserVpcStatus Updates the status of the VPC border firewall for a pay-as-you-go user.

Firewall switch

API

Title

Description

DescribeRegionInfo Retrieve region information Retrieves region information.
DescribeCtrlInstanceMemberAccounts DescribeCtrlInstanceMemberAccounts Queries a list of member accounts.
DescribeFirewallTask DescribeFirewallTask Retrieves the details of 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 DescribeAssetRiskList Retrieves a list of asset risk levels.
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 PutEnableFwSwitch Enable the firewall.
PutEnableAllFwSwitch PutEnableAllFwSwitch Enables all firewall switches.
PutDisableFwSwitch PutDisableFwSwitch Disables a firewall switch.
PutDisableAllFwSwitch PutDisableAllFwSwitch Disables all firewall switches.
NAT Border Firewall NAT Border Firewall
DescribeNatFirewallQuota DescribeNatFirewallQuota Retrieves the quotas for a NAT firewall.
DescribeNatFirewallList DescribeNatFirewallList Queries NAT firewall details.
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 DeleteSecurityProxy Deletes the specified NAT firewall.
VPC perimeter firewall VPC perimeter firewall
DescribeVpcFirewallSummaryInfo DescribeVpcFirewallSummaryInfo Retrieves a summary of VPC firewalls.
DescribeVpcFirewallAccessDetail DescribeVpcFirewallAccessDetail Queries the access details of a VPC firewall.
DescribeVpcFirewallPrecheckDetail DescribeVpcFirewallPrecheckDetail Retrieves the details of a VPC firewall precheck.
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 DescribeTrFirewallsV2Detail Retrieves the details of a VPC firewall for a transit router.
DescribeTrFirewallsV2RouteList DescribeTrFirewallsV2RouteList Queries the route tables for a VPC firewall for a transit router.
DescribeTrFirewallV2RoutePolicyList DescribeTrFirewallV2RoutePolicyList Queries 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 CreateTrFirewallV2 Creates a VPC firewall for a transit router.
CreateTrFirewallV2RoutePolicy Create TR firewall routing rule Create a TR firewall routing rule.
ModifyTrFirewallV2Configuration ModifyTrFirewallV2Configuration Modifies the configuration of a VPC firewall for a transit router.
ModifyFirewallV2RoutePolicySwitch ModifyFirewallV2RoutePolicySwitch Enables or disables a routing policy.
ModifyTrFirewallV2RoutePolicyScope ModifyTrFirewallV2RoutePolicyScope Modifies the scope of a routing policy for a VPC firewall that is created for a Transit Router (TR).
DeleteTrFirewallV2 DeleteTrFirewallV2 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 DescribeVpcFirewallCenDetail Retrieves the details of a VPC firewall that protects traffic between a network instance in a Cloud Enterprise Network (CEN) and a specified VPC.
DescribeNetworkInstanceList DescribeNetworkInstanceList Queries a list of network instances.
DescribeVpcZone DescribeVpcZone Queries the zones that are available for VPCs.
DescribeVpcFirewallZone DescribeVpcFirewallZone Describes the available zones for a VPC firewall.
DescribeVpcFirewallManualVSwitchList DescribeVpcFirewallManualVSwitchList Queries the list of vSwitches for a VPC firewall created in manual mode.
CreateVpcFirewallCenConfigure CreateVpcFirewallCenConfigure Creates a VPC border firewall (protects mutual access traffic between network instances within a Cloud Enterprise Network (CEN) 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 firewall for Cloud Enterprise Network Deletes a VPC firewall that protects traffic between network instances in a Cloud Enterprise Network (CEN) and a specified VPC.
high-speed channel high-speed channel
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 ModifyVpcFirewallConfigure Modifies the configuration of a VPC firewall that protects traffic between two VPCs connected by an Express Connect circuit.
ModifyVpcFirewallSwitchStatus ModifyVpcFirewallSwitchStatus Enables or disables a VPC firewall. A VPC firewall protects traffic between two VPCs that are connected by an Express Connect circuit.
DeleteVpcFirewallConfigure Delete a VPC firewall Deletes a virtual private cloud (VPC) firewall that protects traffic between two VPCs connected through Express Connect.

flow analysis

API

Title

Description

Active outreach Active outreach
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 DescribeOutgoingDestinationCategory Queries the categories of outbound connection destinations.
DescribeOutgoingTag DescribeOutgoingTag Queries outbound connection tags.
DescribeOutgoingDomain DescribeOutgoingDomain Retrieves information about outbound domain names.
DescribeOutgoingDomainDetail DescribeOutgoingDomainDetail Retrieves details about an outbound domain.
DescribeOutgoingDestination DescribeOutgoingDestination This operation queries outbound 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 DescribeInternetOpenIp Describes a Cloud Firewall access control policy group.
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 exchange visits VPC exchange visits
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 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.
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.
Fall-down perception Fall-down perception
DescribeInvadeEventList DescribeInvadeEventList Queries Cloud Firewall threat detection events.
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 EnableSdlProtectedAsset Enables data breach protection for assets.
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 DescribeAclWhitelist Queries the Access Control List (ACL) whitelist.
Boundaries of the Internet Boundaries of the Internet
DescribeAclRuleCount Retrieve total ACL configuration count Retrieves the total number of access control policy configurations.
DescribeControlPolicy DescribeControlPolicy 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.
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 ModifyNatFirewallControlPolicyPosition 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 Boundary VPC Boundary
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 DescribeVpcFirewallControlPolicy Retrieves all access control policies for a specific VPC boundary 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 boundary DNS boundary
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 AddDnsFirewallPolicy Add a DNS firewall ACL
ModifyDnsFirewallPolicy ModifyDnsFirewallPolicy 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 ModifyIpsRulesToDefault Resets Intrusion Prevention System (IPS) rules to the default settings.
DescribeSignatureLibVersion DescribeSignatureLibVersion Queries the version information of the signature library.
Boundaries of the Internet Boundaries of the Internet
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 ModifyDefaultIPSConfig Modifies the default intrusion prevention system (IPS) configuration.
ModifyUserIPSWhitelist ModifyUserIPSWhitelist Modifies the intrusion prevention system (IPS) whitelist for the Internet Border.
Private Network Traceability Private Network Traceability
DescribeIpsPrivateAssoc DescribeIpsPrivateAssoc Queries the list of IPS Private IP Tracing associations.
CreateIpsPrivateAssoc CreateIpsPrivateAssoc Creates an association for private IP traffic tracing with the Intrusion Prevention System (IPS).
DeleteIpsPrivateAssoc DeleteIpsPrivateAssoc Creates a private network association for an IPS.
VPC Boundary VPC Boundary
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 Check TLS Check
ListTlsInspectCACertificates ListTlsInspectCACertificates This operation lists the Transport Layer Security (TLS) inspection certificate authority (CA) certificates.
GetTlsInspectCertificateDownloadUrl GetTlsInspectCertificateDownloadUrl Retrieves the download path for the certificate of a Transport Layer Security (TLS) inspection policy.
strategy analysis strategy 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 ACL check Creates an ACL check.
UpdateAclCheckDetailStatus Modify ACL Check Detail Status Modify the status of ACL check details.
Address Book Address Book
DescribeAddressBook DescribeAddressBook Queries address books in a batch.
AddAddressBook Create Address Book Create an address book, including IPv4 address book, ECS tag address book, IPv6 address book, domain address book, and ACK address book.
ModifyAddressBook Modify Address Book Modify an address book.
DeleteAddressBook Delete an address book Deletes an address book.
Synchronize nodes Synchronize nodes
DescribeAccessInstanceRegionList Query synchronization node region list Queries the list of regions for synchronization nodes.
DescribeAccessInstanceTask DescribeAccessInstanceTask Queries the progress of a synchronization task on a 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 Cluster ACK Cluster
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 CreatePrivateDnsEndpoint Create a private DNS endpoint
ModifyPrivateDnsEndpoint ModifyPrivateDnsEndpoint 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.
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

Alarm Notification Alarm Notification
DescribeUserAlarmConfig DescribeUserAlarmConfig Retrieves the user's alert configuration.
ModifyUserAlarmConfig ModifyUserAlarmConfig Modifies user alert configuration.
Unified management of multiple accounts Unified management of multiple accounts
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 AddInstanceMembers 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.

Abandoned

API

Title

Description

DescribePageDocuments Query page FAQ (deprecated) Queries the FAQ of 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.

Other

API

Title

Description

DescribeIPSRules DescribeIPSRules Query IPS rules
DescribeVpcFirewallTrafficAssetList DescribeVpcFirewallTrafficAssetList Retrieves a list of assets that access domain names through a 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.

Others

API

Title

Description

CreateSlsLogDispatch Create Cloud firewall SLS log delivery Creates a log delivery configuration for Cloud Firewall to Simple Log Service (SLS).
DescribePostpayBill Query pay-as-you-go 2.0 bills Queries pay-as-you-go 2.0 bills.
DescribeRiskEventPayload DescribeRiskEventPayload Queries the attack payloads of intrusion events.
ModifyControlPolicy ModifyControlPolicy Modifies the configurations of an access control policy.