API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (waf-openapi/2021-10-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Instance information
|
API |
Title |
Description |
| CreatePostpaidInstance | CreatePostpaidInstance | Creates a pay-as-you-go Web Application Firewall (WAF) 3.0 instance. |
| DescribeInstance | DescribeInstance | Retrieves the details of the Web Application Firewall (WAF) instance in your Alibaba Cloud account. |
| ReleaseInstance | ReleaseInstance | Releases a Web Application Firewall (WAF) 3.0 instance. |
Onboarding
|
API |
Title |
Description |
| Cloud product access | Cloud product access | |
| DescribeAbnormalCloudResources | DescribeAbnormalCloudResources | Queries abnormal cloud resources added in cloud native mode. |
| ReCreateCloudResource | ReCreateCloudResource | Re-adds a cloud product to Web Application Firewall (WAF) to restore protection after a cloud product access failure. |
| SyncProductInstance | SyncProductInstance | Synchronizes Elastic Compute Service (ECS), Classic Load Balancer (CLB), and Network Load Balancer (NLB) instances to Web Application Firewall (WAF). |
| DescribeCloudResources | DescribeCloudResources | Queries the list of cloud services added to Web Application Firewall (WAF). |
| DescribeResourcePort | DescribeResourcePort | Queries the ports of a cloud service instance that are added to Web Application Firewall (WAF). |
| DescribeProductInstances | DescribeProductInstances | Queries synchronized cloud service instances. |
| DescribeResourceSupportRegions | DescribeResourceSupportRegions | Queries the list of regions supported by cloud native mode, primarily for CLB and ECS products. |
| DescribeResourceRegionId | DescribeResourceRegionId | Queries the region IDs of cloud service resources that can be added to Web Application Firewall (WAF) by using the SDK. |
| DescribeResourceInstanceCerts | DescribeResourceInstanceCerts | Queries the certificates of a cloud product instance. This operation is available only in multi-account scenarios and returns the certificates of both the delegated administrator and the member that owns the instance. For example, if user A is a delegated administrator with cert1 and the instance lb-xx-1 belongs to member B who has cert2, a query for the instance lb-xx-1 returns both cert1 and cert2. |
| CreateCloudResource | CreateCloudResource | Integrates cloud products with Web Application Firewall (WAF). Currently, only Elastic Compute Service (ECS) and Classic Load Balancer (CLB) are supported. |
| ModifyCloudResource | ModifyCloudResource | Modifies the configuration of a cloud resource connected to WAF. |
| DeleteCloudResource | DeleteCloudResource | Removes a cloud service from Web Application Firewall (WAF). This operation currently supports only Elastic Compute Service (ECS) and Classic Load Balancer (CLB). |
| DescribeCloudResourceAccessedPorts | DescribeCloudResourceAccessedPorts | Queries the ports of cloud services added to Web Application Firewall (WAF). This operation is supported only for Elastic Compute Service (ECS) and Classic Load Balancer (CLB). |
| DescribeCloudResourceAccessPortDetails | Query the details of cloud service instance ports that are added to WAF | Retrieves port details of cloud service instances onboarded to Web Application Firewall (WAF). |
| ModifyCloudResourceCert | ModifyCloudResourceCert | Modifies the certificate for a resource managed by WAF in cloud native mode. |
| DescribeCloudResourceList | DescribeCloudResourceList | Queries a list of resources added to Web Application Firewall (WAF) in cloud native mode. |
| ModifyCloudResourceDefaultCert | ModifyCloudResourceDefaultCert | Modifies the default certificate for cloud native mode. |
| DeleteCloudResourceExtensionCert | DeleteCloudResourceExtensionCert | Deletes an extension certificate for cloud native mode. |
| CreateCloudResourceExtensionCert | CreateCloudResourceExtensionCert | Adds an extension certificate for cloud native mode. |
| CNAME access | CNAME access | |
| DescribeDomainUsedPorts | DescribeDomainUsedPorts | Queries the ports used by all domain names that are added in CNAME record mode and hybrid cloud mode with public network disaster recovery enabled. |
| ModifyDomain | ModifyDomain | Updates a CNAME-based domain name onboarded to Web Application Firewall (WAF). |
| DescribeDomains | DescribeDomains | Queries the domain names that are added to Web Application Firewall (WAF). |
| DescribeDomainDetail | DescribeDomainDetail | Retrieves the access configuration details of a domain name onboarded to Web Application Firewall (WAF). |
| DescribePunishedDomains | DescribePunishedDomains | Queries penalties for domain names added to Web Application Firewall (WAF) without an Internet Content Provider (ICP) filing. |
| ModifyDomainPunishStatus | ModifyDomainPunishStatus | Re-add a domain name that was penalized for not having an ICP filing to Web Application Firewall (WAF). |
| DescribeCertDetail | DescribeCertDetail | Retrieves certificate details, including the certificate name, expiration time, issuance time, and associated domain name. |
| DescribeCerts | DescribeCerts | Retrieves the list of certificates for a user. |
| DescribeDomainDNSRecord | DescribeDomainDNSRecord | Verifies that the DNS record of a domain name is correct. |
| DescribeWafSourceIpSegment | DescribeWafSourceIpSegment | Queries the back-to-origin CIDR blocks of a Web Application Firewall (WAF) instance. |
| DescribeDDoSStatus | DescribeDDoSStatus | Checks whether the current WAF instance is under a Distributed Denial of Service (DDoS) attack. |
| CreateSM2Cert | CreateSM2Cert | Uploads an SM certificate for CNAME record access to Web Application Firewall (WAF). |
| DescribeCnameCount | DescribeCnameCount | Queries the total number of domain names added to WAF, including those in canonical name (CNAME) mode and hybrid cloud mode. |
| DescribeDefaultHttps | DescribeDefaultHttps | Queries the default SSL/TLS settings of a Web Application Firewall (WAF) instance. |
| ModifyDefaultHttps | ModifyDefaultHttps | Modifies the default SSL/TLS settings. |
| CreateCerts | CreateCerts | Uploads a certificate that uses an internationally accepted algorithm for a domain name added to Web Application Firewall (WAF) in CNAME record mode. |
| VerifyDomainOwner | VerifyDomainOwner | Verifies that you own the specified domain name. Domain ownership must be verified before you can add a domain name to Web Application Firewall (WAF) by using CNAME access. |
| DescribeVerifyContent | DescribeVerifyContent | Queries the domain ownership verification content of a Web Application Firewall (WAF) instance. |
| ModifyDomainCert | ModifyDomainCert | Modifies the certificate that is associated with a domain name added to a Web Application Firewall (WAF) instance in CNAME record mode. |
| Hybrid cloud access | Hybrid cloud access | |
| DescribeHybridCloudResources | DescribeHybridCloudResources | Queries the domain names that are added to Web Application Firewall (WAF) in hybrid cloud mode. |
| DescribeHybridCloudProtectableCount | DescribeHybridCloudProtectableCount | Queries the count of protectable nodes that can be added to a hybrid cloud cluster. |
Protection configuration
|
API |
Title |
Description |
| Protection object | Protection object | |
| CreateDefenseResource | CreateDefenseResource | Creates a protected object. |
| DeleteDefenseResource | DeleteDefenseResource | Deletes a protected object. |
| CreateDefenseResourceGroup | CreateDefenseResourceGroup | Creates a protected object group. |
| ModifyDefenseResourceGroup | ModifyDefenseResourceGroup | Modifies the configuration of a protected object group. |
| DeleteDefenseResourceGroup | DeleteDefenseResourceGroup | Deletes a protected object group. |
| DescribeDefenseResourceGroup | DescribeDefenseResourceGroup | Retrieves the details of a protected object group. |
| DescribeDefenseResourceGroups | DescribeDefenseResourceGroups | Retrieves information about protected object groups using pagination. |
| DescribeDefenseResourceGroupNames | DescribeDefenseResourceGroupNames | Queries the names of protected object groups. |
| DescribeDefenseResource | DescribeDefenseResource | Retrieves the details of a protected object. |
| DescribeDefenseResources | DescribeDefenseResources | Queries a list of protected objects. |
| DescribeDefenseResourceNames | DescribeDefenseResourceNames | Performs a pagination query to retrieve the names of protected objects. |
| DescribeDefenseResourceOwnerUid | DescribeDefenseResourceOwnerUid | Queries the asset owner account of protected objects in multi-account management scenarios. |
| ModifyDefenseResourceXff | ModifyDefenseResourceXff | Modifies the cookie settings of a protected object and the method to identify the originating IP addresses of clients. |
| DescribePauseProtectionStatus | DescribePauseProtectionStatus | Queries the protection pause status of a Web Application Firewall (WAF) instance. |
| DescribeDefenseGroupValidResources | DescribeDefenseGroupValidResources | Queries a paginated list of protected objects that can be associated with a defense group. |
| Protection rules | Protection rules | |
| DescribeBaseRuleChangeLog | DescribeBaseRuleChangeLog | Queries protection rule change logs on a paginated basis. |
| CreateDefenseTemplate | CreateDefenseTemplate | Creates a protection template. |
| ModifyDefenseTemplate | ModifyDefenseTemplate | Modifies a defense template. |
| ModifyDefenseTemplateStatus | ModifyDefenseTemplateStatus | Changes the status of a protection rule template. |
| CopyDefenseTemplate | CopyDefenseTemplate | Copies a protection template. |
| DeleteDefenseTemplate | DeleteDefenseTemplate | Deletes a protection rule template. |
| DescribeDefenseTemplate | DescribeDefenseTemplate | Retrieves the details of a specific protection template. |
| DescribeDefenseTemplates | DescribeDefenseTemplates | Retrieves a paginated list of protection templates. |
| ModifyTemplateResources | ModifyTemplateResources | Attaches protected objects to or detaches protected objects from a protection template. |
| DescribeTemplateResources | DescribeTemplateResources | Queries the resources attached to a protection template. |
| DescribeTemplateResourceCount | DescribeTemplateResourceCount | Queries the number of protected resources that are associated with one or more protection templates. |
| DescribeDefenseTemplateValidResources | DescribeDefenseTemplateValidResources | Queries a paginated list of protected objects that are valid for a specified protection template. |
| DescribeDefenseTemplateValidGroups | DescribeDefenseTemplateValidGroups | Queries the names of protected object groups that can be associated with a specific protection template. |
| DescribeDefenseResourceTemplates | DescribeDefenseResourceTemplates | Queries the protection templates associated with a protected object or protected object group. |
| CreateDefenseRule | CreateDefenseRule | Creates a web core protection rule. |
| ModifyDefenseRule | ModifyDefenseRule | Modifies the configuration of a protection rule. |
| ModifyDefenseRuleStatus | ModifyDefenseRuleStatus | Enables or disables a protection rule. |
| DeleteDefenseRule | DeleteDefenseRule | Deletes the specified protection rules. |
| DescribeDefenseRules | DescribeDefenseRules | Queries a paginated list of protection rules. |
| DescribeDefenseRule | DescribeDefenseRule | Retrieves the details of a specified protection rule. |
| ModifyDefenseRuleCache | ModifyDefenseRuleCache | Updates the cache for a web tamper-proofing rule. |
| DeleteDefenseRuleBlockIp | DeleteDefenseRuleBlockIp | Unblocks an IP address that is blocked by the scan protection module. |
| DescribeRelatedDefenseRules | DescribeRelatedDefenseRules | Queries a paginated list of associated protection rules. |
| DescribeIpAbroadCountryInfos | DescribeIpAbroadCountryInfos | Retrieves supported countries and regions outside China for IP-based region blacklist. |
| DescribeRuleGroups | DescribeRuleGroups | Queries a paginated list of regular expression rule groups. |
| ModifyDefenseSceneConfig | ModifyDefenseSceneConfig | Modifies the mitigation settings for a protection scenario. |
| DescribeDefenseSceneConfig | DescribeDefenseSceneConfig | Queries the protection configurations for a specific defense scenario. |
| DescribeDefenseRuleStatistics | DescribeDefenseRuleStatistics | Queries the statistics of rules in a specified Web Application Firewall (WAF) protection module. |
| DescribeBaseSystemRules | DescribeBaseSystemRules | Queries the system rules for Web Application Firewall (WAF) protection. |
| DescribeCustomBaseRuleCompileResult | DescribeCustomBaseRuleCompileResult | Describes the compilation result of a custom regular expression rule. |
| DescribeBotRuleLabels | DescribeBotRuleLabels | Queries the labels of bot management rules. |
| DescribeBotAppKey | DescribeBotAppKey | Queries the AppKey for bot management. |
| Critical event protection | Critical event protection | |
| CreateMajorProtectionBlackIp | CreateMajorProtectionBlackIp | Creates an IP address blacklist for critical event protection. |
| ModifyMajorProtectionBlackIp | ModifyMajorProtectionBlackIp | Modifies an IP address blacklist for critical event protection. |
| DeleteMajorProtectionBlackIp | DeleteMajorProtectionBlackIp | Deletes an IP address from the blacklist for critical event protection. |
| ClearMajorProtectionBlackIp | ClearMajorProtectionBlackIp | Clears the IP blacklist for a critical event protection rule. |
| DescribeMajorProtectionBlackIps | DescribeMajorProtectionBlackIps | Queries the IP address blacklist for critical event protection in a paginated format. |
| Address book | Address book | |
| AddAddress | AddAddress | Adds one or more IP addresses or CIDR blocks to an address book in a Web Application Firewall (WAF) instance. Address books can be referenced in protection rules for centralized IP address management. |
| DescribeAddresses | DescribeAddresses | Queries a paginated list of addresses in an address book. |
| DeleteAddress | DeleteAddress | Deletes addresses from an address book. |
| ClearAddress | ClearAddress | Clears all addresses from a Web Application Firewall (WAF) address book. |
API security
|
API |
Title |
Description |
| DeleteApisecAbnormals | DeleteApisecAbnormals | Deletes API security risks in a batch. |
| ModifyApisecAbnormals | ModifyApisecAbnormals | Modifies the status of API security risks in batches. |
| DescribeApisecAssetTrend | DescribeApisecAssetTrend | Queries the trend of API assets detected by the API security module of Web Application Firewall (WAF). |
| DescribeApisecAbnormalDomainStatistic | DescribeApisecAbnormalDomainStatistic | Queries the API security risk statistics for domain names that are protected by Web Application Firewall (WAF). |
| DescribeApisecEventDomainStatistic | DescribeApisecEventDomainStatistic | Queries API security event statistics grouped by domain name for a Web Application Firewall (WAF) instance. |
| DescribeApisecSensitiveDomainStatistic | DescribeApisecSensitiveDomainStatistic | Queries statistics on domain names where sensitive data is detected by the API security module. |
| ModifyApisecEvents | ModifyApisecEvents | Modifies the status of a batch of API security events. |
| DeleteApisecEvents | DeleteApisecEvents | Deletes API security events in batches. |
| ModifyApisecLogDeliveryStatus | ModifyApisecLogDeliveryStatus | Modifies the log delivery status of an API security module in a Web Application Firewall (WAF) instance. |
| CreateApiExport | CreateApiExport | Creates a task to export API security data. |
| DescribeApiExports | DescribeApiExports | Queries a list of API security export tasks. |
| DescribeApisecAbnormals | DescribeApisecAbnormals | Queries the API security risks that are detected by Web Application Firewall (WAF). |
| DescribeApisecApiResources | DescribeApisecApiResources | Queries a list of API security assets that are protected by Web Application Firewall (WAF). |
| ModifyApisecStatus | ModifyApisecStatus | Modifies the API security status for a protected object or a protected object group. |
| ModifyApisecModuleStatus | ModifyApisecModuleStatus | Enables or disables API security features for a protected object or protected object group in the Web Application Firewall (WAF) API security module. |
| ModifyApisecApiResource | ModifyApisecApiResource | Modifies the annotation of an API asset in the API security module of Web Application Firewall (WAF). |
| DescribeUserEventType | DescribeUserEventType | Queries the types and statistics of user security events. |
| DescribeUserEventTrend | DescribeUserEventTrend | Queries the trend of API security events for a Web Application Firewall (WAF) instance. |
| DescribeUserAsset | DescribeUserAsset | Queries user asset statistics for API Security. |
| DescribeUserApiRequest | DescribeUserApiRequest | Queries traffic statistics for an API operation. |
| DescribeUserAbnormalType | DescribeUserAbnormalType | Queries user risk types and statistics related to API security in Web Application Firewall (WAF). |
| DescribeUserAbnormalTrend | DescribeUserAbnormalTrend | Queries the trend of API security risks for a Web Application Firewall (WAF) instance. |
| DescribeSensitiveStatistic | DescribeSensitiveStatistic | Queries statistics on sensitive data for data leakage prevention. |
| DescribeSensitiveRequests | DescribeSensitiveRequests | Queries the results of sensitive data tracing. |
| DescribeSensitiveRequestLog | DescribeSensitiveRequestLog | Queries access logs for sensitive data. |
| DescribeSensitiveOutboundTrend | DescribeSensitiveOutboundTrend | Queries the trend of sensitive outbound data detected by Web Application Firewall (WAF). |
| DescribeSensitiveOutboundStatistic | DescribeSensitiveOutboundStatistic | Queries statistics about outbound transfers of personal information. |
| DescribeSensitiveOutboundDistribution | DescribeSensitiveOutboundDistribution | Queries the distribution of outbound traffic that contains personal information. |
| DescribeSensitiveDetectionResult | DescribeSensitiveDetectionResult | Queries the compliance detection results for API security. |
| DescribeSensitiveApiStatistic | DescribeSensitiveApiStatistic | Queries statistics for domain names and APIs that handle personal information. |
| DescribeFreeUserEvents | DescribeFreeUserEvents | Queries security events detected by the basic API security scan. |
| DescribeFreeUserEventTypes | DescribeFreeUserEventTypes | Queries the types of security events for basic API security detection. |
| DescribeFreeUserEventCount | DescribeFreeUserEventCount | Queries statistics about security events detected by basic API security checks. |
| DescribeFreeUserAssetCount | DescribeFreeUserAssetCount | Queries statistics information about assets detected by the basic API security feature. |
| DescribeApisecUserOperations | DescribeApisecUserOperations | Queries user operation records for API security of Web Application Firewall (WAF). |
| DescribeApisecSuggestions | DescribeApisecSuggestions | Queries security suggestions for API assets. |
| DescribeApisecStatistics | DescribeApisecStatistics | Queries statistics for API security risks or security events. |
| DescribeApisecRules | DescribeApisecRules | Queries the rules of an API security policy. |
| DescribeApisecProtectionResources | DescribeApisecProtectionResources | Queries the protected objects of a Web Application Firewall (WAF) instance for which API security is enabled. |
| DescribeApisecProtectionGroups | DescribeApisecProtectionGroups | Retrieves a list of active API security protection object groups. |
| DescribeApisecMatchedHosts | DescribeApisecMatchedHosts | Queries the list of domain names that are protected by API security. |
| DescribeApisecEvents | DescribeApisecEvents | Queries a list of API security events. |
| DescribeApisecEventDetail | DescribeApisecEventDetail | Retrieves the details of an API security event. |
| DescribeApisecLogDeliveries | DescribeApisecLogDeliveries | Queries the configurations of API security log subscription. |
| DescribeApisecSlsLogStores | DescribeApisecSlsLogStores | Queries the Logstores whose names start with apisec- in Simple Log Service. |
| DescribeApisecSlsProjects | DescribeApisecSlsProjects | Queries the projects whose names start with apisec- in Simple Log Service. |
| ModifyApisecLogDelivery | ModifyApisecLogDelivery | Updates the API security log subscription settings. |
| DescribeApisecExamples | DescribeApisecExamples | Queries the API security examples that are detected by Web Application Firewall (WAF). |
Report information
|
API |
Title |
Description |
| DescribeNetworkFlowTimeSeriesMetric | DescribeNetworkFlowTimeSeriesMetric | Queries the time series statistics of all traffic, including malicious requests and normal service requests. |
| DescribeSecurityEventTopNMetric | DescribeSecurityEventTopNMetric | Queries the top N statistics for attack traffic. Attack traffic is aggregated by a specified dimension, sorted, and the top N results are returned. |
| DescribeSecurityEventTimeSeriesMetric | DescribeSecurityEventTimeSeriesMetric | Queries the time series data of attack traffic. Attack requests are requests that hit a rule and are identified as a threat. |
| DescribeSecurityEventLogs | DescribeSecurityEventLogs | Queries the detailed logs of attack traffic. Each log entry contains the details of a request that matched a protection rule. |
| DescribeNetworkFlowTopNMetric | DescribeNetworkFlowTopNMetric | Queries the top N statistics for all traffic that passes through Web Application Firewall (WAF), including malicious and normal service requests. The results are aggregated by different dimensions and sorted in descending order. |
| DescribeFlowChart | DescribeFlowChart | Queries the traffic statistics. |
| DescribePeakTrend | DescribePeakTrend | Queries the trend of queries per second (QPS). |
| DescribeResponseCodeTrendGraph | DescribeResponseCodeTrendGraph | Queries the trend of abnormal response codes, such as 5xx, 405, 499, 302, and 444, that are returned by Web Application Firewall (WAF) to clients or by origin servers to WAF. |
| DescribeVisitUas | DescribeVisitUas | Queries the top 10 User-Agents that sent the most requests. |
| DescribeVisitTopIp | DescribeVisitTopIp | Queries the top 10 IP addresses that have the highest number of requests. |
| DescribeRuleHitsTopResource | DescribeRuleHitsTopResource | Queries the top 10 protected objects that triggered protection rules most frequently. |
| DescribeRuleHitsTopRuleId | DescribeRuleHitsTopRuleId | Queries the top 10 rule IDs that are triggered most frequently. |
| DescribeRuleHitsTopTuleType | DescribeRuleHitsTopTuleType | Queries the top 10 most frequently triggered protection rule types. |
| DescribeRuleHitsTopUrl | DescribeRuleHitsTopUrl | Queries the top 10 URLs that trigger protection rules most frequently. |
| DescribeRuleHitsTopClientIp | DescribeRuleHitsTopClientIp | Queries the top 10 source IP addresses from which the most attacks originated. |
| DescribeFlowTopResource | DescribeFlowTopResource | Queries the top 10 protected objects by request count. |
| DescribeRuleHitsTopUa | DescribeRuleHitsTopUa | Displays the top 10 User-Agents by number of attacks. |
| DescribeFlowTopUrl | DescribeFlowTopUrl | Queries the top 10 most requested URLs. |
| DescribeThreatEventDetail | DescribeThreatEventDetail | Retrieves the details of a security event that requires attention. |
| DescribeThreatEvent | DescribeThreatEvent | Queries a paginated list of notable security events. |
| DescribeThreatEventTopMetric | DescribeThreatEventTopMetric | Queries the top five security event metrics, which are aggregated by different objects and sorted in descending order. |
| DescribeAlarmList | DescribeAlarmList | Queries a list of alerts. |
| DescribeAlarmBanner | DescribeAlarmBanner | Queries the alert banner information of a Web Application Firewall (WAF) instance. |
Log configuration
|
API |
Title |
Description |
| DescribeUserLogFieldConfig | DescribeUserLogFieldConfig | Queries the log field configuration of a Web Application Firewall (WAF) instance, including additional fields, removed fields, delivery strategies, and extended settings. |
| ModifyUserLogFieldConfig | ModifyUserLogFieldConfig | Modifies the default log field configuration of a Web Application Firewall (WAF) instance for log delivery to Simple Log Service. |
| DescribeCommonLogFields | DescribeCommonLogFields | Queries all log fields supported by Simple Log Service for Web Application Firewall (WAF). |
| ModifyUserWafLogStatus | ModifyUserWafLogStatus | Enables or disables Simple Log Service for Web Application Firewall (WAF). |
| DescribeUserWafLogStatus | DescribeUserWafLogStatus | Queries the status, region ID, and status modification time of Web Application Firewall (WAF) logs. |
| DescribeUserSlsLogRegions | DescribeUserSlsLogRegions | Queries the available log storage regions. |
| DescribeSlsAuthStatus | DescribeSlsAuthStatus | Queries the Logstore authorization status. |
| DescribeSlsLogStoreStatus | DescribeSlsLogStoreStatus | Queries the status of a Simple Log Service Logstore. |
| DescribeSlsLogStore | DescribeSlsLogStore | Retrieves Logstore information, including total capacity, storage duration, and used capacity. |
| ModifyResourceLogStatus | ModifyResourceLogStatus | Enables or disables the log collection feature for a protected object. |
| DescribeResourceLogStatus | DescribeResourceLogStatus | Queries the log collection status of protected objects in a Web Application Firewall (WAF) instance. |
| CreateLogDeliveryConfig | CreateLogDeliveryConfig | Creates a log delivery configuration for a Web Application Firewall (WAF) instance in a hybrid cloud. |
| ModifyLogDeliveryConfig | ModifyLogDeliveryConfig | Modifies a log delivery configuration for a hybrid cloud cluster. |
| DeleteLogDeliveryConfig | DeleteLogDeliveryConfig | Deletes a log delivery configuration. |
| DescribeLogDeliveryConfig | DescribeLogDeliveryConfig | Queries a single log delivery configuration for a hybrid cloud. |
| DescribeLogDeliveryConfigs | DescribeLogDeliveryConfigs | Queries all log delivery configurations of a Web Application Firewall (WAF) instance for hybrid cloud. |
| ModifyResourceLogFieldConfig | ModifyResourceLogFieldConfig | Modifies the log field configuration of a protected object. |
| DescribeResourceLogFieldConfig | DescribeResourceLogFieldConfig | Queries the log field configuration for a protected object. |
| ModifyResourceLogDeliveryStatus | ModifyResourceLogDeliveryStatus | Modifies the log delivery status of a protected object in Web Application Firewall (WAF). |
| DescribeResourceLogDeliveryStatus | DescribeResourceLogDeliveryStatus | Queries the log delivery status for protected objects. |
Hybrid cloud cluster management
|
API |
Title |
Description |
| DescribeHybridCloudClusterServers | DescribeHybridCloudClusterServers | Queries the servers in a hybrid cloud Web Application Firewall (WAF) cluster. |
| DescribeHybridCloudBasicMonitor | DescribeHybridCloudBasicMonitor | Queries the system status of a node in a hybrid cloud cluster. |
| CreateHybridCloudCluster | CreateHybridCloudCluster | Creates a hybrid cloud Web Application Firewall (WAF) cluster. |
| DescribeHybridCloudServerRegions | DescribeHybridCloudServerRegions | Queries hybrid cloud server regions, including carriers, continents, and cities. |
| DescribeHybridCloudUnassignedMachines | DescribeHybridCloudUnassignedMachines | Queries the list of unassigned servers in a hybrid cloud cluster. |
| ModifyHybridCloudClusterBypassStatus | ModifyHybridCloudClusterBypassStatus | Modifies the manual bypass status for a hybrid cloud cluster that is integrated with an SDK. |
| DescribeHybridCloudUser | DescribeHybridCloudUser | Queries the available HTTP and HTTPS port ranges for hybrid cloud access. |
| DescribeHybridCloudGroups | DescribeHybridCloudGroups | Queries the Hybrid Cloud WAF node groups that are added to Web Application Firewall (WAF). |
| CreateHybridCloudGroup | CreateHybridCloudGroup | Creates a node group in a Hybrid Cloud Web Application Firewall (WAF) cluster. |
| DescribeHybridCloudClusterRule | DescribeHybridCloudClusterRule | Retrieves a hybrid cloud cluster rule. |
| DescribeHybridCloudClusters | DescribeHybridCloudClusters | Queries a list of hybrid cloud clusters. |
| ModifyHybridCloudClusterRule | ModifyHybridCloudClusterRule | Modifies the rule of a hybrid cloud cluster. |
| ModifyHybridCloudGroup | ModifyHybridCloudGroup | Modifies the information of a cluster group. |
| ModifyHybridCloudGroupExpansionServer | ModifyHybridCloudGroupExpansionServer | Adds a node to a node group in a hybrid cloud cluster of a Web Application Firewall (WAF) instance. |
| ModifyHybridCloudGroupShrinkServer | ModifyHybridCloudGroupShrinkServer | Removes a node from a group in a hybrid cloud cluster. |
| ModifyHybridCloudSdkPullinStatus | ModifyHybridCloudSdkPullinStatus | Modifies the traffic redirection status of a hybrid cloud SDK. |
| ModifyHybridCloudServer | ModifyHybridCloudServer | Modifies the configuration of a hybrid cloud node in a Web Application Firewall (WAF) instance. |
| DeleteHybridCloudClusterRule | DeleteHybridCloudClusterRule | Deletes a hybrid cloud cluster rule from a Web Application Firewall (WAF) instance. |
| CreateHybridCloudClusterRule | CreateHybridCloudClusterRule | Creates a Hybrid Cloud Web Application Firewall (WAF) cluster rule. |
| DescribeHybridCloudClusterRules | DescribeHybridCloudClusterRules | Cluster rules |
| DescribeHybridCloudProcessMonitor | DescribeHybridCloudProcessMonitor | Queries the status of applications on nodes in a hybrid cloud Web Application Firewall (WAF) cluster. |
| DescribeHybridCloudResourceDetail | DescribeHybridCloudResourceDetail | Retrieves the details of a hybrid cloud domain name. |
| DescribeHybridCloudSdkServers | DescribeHybridCloudSdkServers | Queries the hybrid cloud SDK servers that are managed by a Web Application Firewall (WAF) instance. |
| DescribeHybridCloudSupportRegions | DescribeHybridCloudSupportRegions | Queries the regions that are supported for hybrid cloud access in Web Application Firewall (WAF). |
| DescribeHybridCloudUnsupportPorts | DescribeHybridCloudUnsupportPorts | Queries the list of unsupported ports for a hybrid cloud. |
| DeleteHybridCloudGroup | DeleteHybridCloudGroup | Deletes a group. |
| ModifyHybridCloudCluster | ModifyHybridCloudCluster | Updates hybrid cloud cluster settings, such as the cluster name, ports, and access mode. |
Multi-account management
|
API |
Title |
Description |
| CreateMemberAccounts | CreateMemberAccounts | Adds member accounts to use the multi-account management feature of Web Application Firewall (WAF). |
| ModifyMemberAccount | ModifyMemberAccount | Modifies the information of a member account that is managed by the multi-account management feature of Web Application Firewall (WAF). |
| DeleteMemberAccount | DeleteMemberAccount | Deletes a Web Application Firewall (WAF) member account. |
| DescribeAccountDelegatedStatus | DescribeAccountDelegatedStatus | Queries whether an account is a delegated administrator for Web Application Firewall (WAF) using the multi-account management feature. |
| DescribeMemberAccounts | DescribeMemberAccounts | Retrieves all member accounts managed by the WAF multi-account management feature. |
Label management
|
API |
Title |
Description |
| ListTagKeys | ListTagKeys | Queries tag keys. |
| ListTagValues | ListTagValues | Lists the tag values of a specified tag key. |
Pricing
|
API |
Title |
Description |
| DescribeChargeResult | DescribeChargeResult | Queries the billing results for Web Application Firewall (WAF). |
| DescribeChargeModule | DescribeChargeModule | Retrieves the billing module information of Web Application Firewall (WAF). |
Other
|
API |
Title |
Description |
| ModifyPauseProtectionStatus | ModifyPauseProtectionStatus | Modifies the protection status of Web Application Firewall (WAF). |
| CreatePocFunction | CreatePocFunction | Starts a trial for a proof of concept (POC) feature. |
| DescribePocFunctions | DescribePocFunctions | Retrieves the enabled proof of concept (POC) feature trials. |
| DescribeRoleAuthStatus | DescribeRoleAuthStatus | Queries the authorization status of the service-linked role for Web Application Firewall (WAF). |
| InitializeWafOperationRole | InitializeWafOperationRole | Initializes a service-linked role for WAF. |
| DescribeElasticBills | DescribeElasticBills | Queries the daily bills for WAF pay-as-you-go instances for the last 7 days. |
| DescribePrepayDailyBills | DescribePrepayDailyBills | Queries burstable pay-as-you-go charges for a WAF subscription instance, such as burstable QPS. |
Others
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which a protected object belongs. |
| CreateDomain | CreateDomain | Adds a domain name to a Web Application Firewall (WAF) instance for protection. |
| DeleteDomain | DeleteDomain | Deletes a domain name that has been added to Web Application Firewall (WAF) in CNAME record mode. |
| ListTagResources | ListTagResources | Queries the tags that are added to a resource. |
| TagResources | TagResources | Adds tags to resources. |
| UntagResources | UntagResources | Removes tags from resources and then deletes the tags. |