The following tables list API operations available for use in Anti-DDoS Pro or Anti-DDoS Premium.

Note Operations described in this topic apply to only Anti-DDoS Pro or Anti-DDoS Premium.
  • Before you call the following operations, make sure that you have activated Anti-DDoS Pro or Anti-DDoS Premium. For more information, see Purchase Anti-DDoS Pro and Anti-DDoS Premium instances.
  • Unless otherwise specified, the following operations apply to both Anti-DDoS Pro and Anti-DDoS Premium. If some operations apply to only one edition, extra descriptions are provided.

For more information, visit OpenAPI Explorer.

Instance management

API Description
DescribeInstanceIds Queries the IDs of all Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribeInstances Queries the versions and status information of one or more Anti-DDoS Pro or Anti-DDoS Premium instances, such as traffic forwarding status, expiration status, and overdue payment status.
DescribeInstanceDetails Queries the IP addresses and Internet service provider (ISP) lines of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribeInstanceSpecs Queries the specifications of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribeInstanceStatistics Queries the statistics on one or more Anti-DDoS Pro or Anti-DDoS Premium instances, such as the numbers of protected domain names and ports.
ModifyInstanceRemark Modifies the description of an Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribeElasticBandwidthSpec Queries the available burstable protection bandwidth of an Anti-DDoS Pro instance.
ModifyElasticBandWidth Modifies the burstable protection bandwidth of an Anti-DDoS Pro instance.
DescribeDefenseCountStatistics Queries the information of mitigation sessions of an Anti-DDoS Premium instance, such as the numbers of available and used advanced mitigation sessions.
ReleaseInstance Releases an Anti-DDoS Pro or Anti-DDoS Premium instance that has expired.

Access management

Table 1. Domain name-based access
API Description
DescribeDomains Queries domain names for which the forwarding rules are created.
DescribeWebRules Queries the forwarding rules of a website.
CreateWebRule Creates a forwarding rule for a website.
ModifyWebRule Modifies the forwarding rule of a website.
DeleteWebRule Deletes the forwarding rule of a website.
DescribeWebInstanceRelations Queries the information of Anti-DDoS Pro or Anti-DDoS Premium instances that are associated with websites.
AssociateWebCert Associates an SSL certificate with the forwarding rule of a website.
ModifyTlsConfig Modifies the Transport Layer Security (TLS) policy configuration for the forwarding rule of a website.
DescribeWebCustomPorts Queries the supported custom ports of a website.
DescribeWebAccessMode Queries the access mode settings of a website.
ModifyWebAccessMode Modifies the access mode settings of a website.
DescribeCerts Queries the certificate information of a website.
DescribeCnameReuses Queries the CNAME reuse information of websites.
ModifyCnameReuse Enables or disables CNAME reuse for a website.
ModifyHttp2Enable Enables or disables HTTP/2 for the forwarding rule of a website.
Table 2. Port-based access
API Description
DescribeNetworkRules Queries port forwarding rules.
CreateNetworkRules Creates a port forwarding rule.
ConfigNetworkRules Modifies a port forwarding rule.
DeleteNetworkRule Deletes a port forwarding rule.
DescribeHealthCheckList Queries the Layer 4 or Layer 7 health check configuration of a port forwarding rule.
ModifyHealthCheckConfig Modifies the Layer 4 or Layer 7 health check configuration of a port forwarding rule.
DescribeHealthCheckStatus Queries the health status of an origin server.
Table 3. Sec-Traffic Manager
API Description
DescribeSchedulerRules Queries the scheduling rules that are created for Sec-Traffic Manager.
CreateSchedulerRule Creates a scheduling rule for Sec-Traffic Manager.
ModifySchedulerRule Modifies the scheduling rule of Sec-Traffic Manager.
DeleteSchedulerRule Deletes the scheduling rule of Sec-Traffic Manager.

Protection settings

Table 4. Protection policies for infrastructure
API Description
DescribeAutoCcListCount Queries the numbers of IP addresses in the whitelist and blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribeAutoCcBlacklist Queries IP addresses in the blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
AddAutoCcBlacklist Adds IP addresses to the blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
DeleteAutoCcBlacklist Removes IP addresses from the blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
EmptyAutoCcBlacklist Clears IP addresses from the blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribeAutoCcWhitelist Queries IP addresses in the whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
AddAutoCcWhitelist Adds IP addresses to the whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
DeleteAutoCcWhitelist Removes IP addresses from the whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
EmptyAutoCcWhitelist Clears IP addresses from the whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribeUnBlackholeCount Queries the total and remaining quotas that you can deactivate the black hole.
DescribeBlackholeStatus Queries the black hole status of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.
ModifyBlackholeStatus Deactivates the black hole.
DescribeNetworkRegionBlock Queries the blocked regions that are configured for an Anti-DDoS Pro or Anti-DDoS Premium instance.
ConfigNetworkRegionBlock Configures blocked regions for an Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribeBlockStatus Queries the Diversion from Origin Server configurations of one or more Anti-DDoS Pro instances.
ModifyBlockStatus Modifies the Diversion from Origin Server configuration of an Anti-DDoS Pro instance.
DescribeUnBlockCount Queries the remaining quota that you can use the Diversion from Origin Server policy.
Table 5. Protection policies for website services
API Description
DescribeWebCcProtectSwitch Queries the status of each protection policy for websites.
ModifyWebAIProtectSwitch Enables or disables the Intelligent Protection policy for a website.
ModifyWebAIProtectMode Modifies the mode settings of the Intelligent Protection policy for a website.
ModifyWebIpSetSwitch Enables or disables the Black Lists and White Lists (Domain Names) policy for a website.
ConfigWebIpSet Configures the IP address whitelist and blacklist for a website.
EnableWebCC Enables the Frequency Control policy for a website.
DisableWebCC Disables the Frequency Control policy for a website.
ConfigWebCCTemplate Configures the mode of the Frequency Control policy for a website.
EnableWebCCRule Turns on the Custom Rule switch of the Frequency Control policy for a website.
DisableWebCCRule Turns off the Custom Rule switch of the Frequency Control policy for a website.
DescribeWebCCRules Queries the custom frequency control rules that are created for a website.
CreateWebCCRule Creates a custom frequency control rule for a website.
ModifyWebCCRule Modifies the custom frequency control rule of a website.
DeleteWebCCRule Deletes the custom frequency control rule of a website.
ModifyWebPreciseAccessSwitch Enables or disables the Accurate Access Control policy for a website.
DescribeWebPreciseAccessRule Queries the accurate access control rules that are created for websites.
ModifyWebPreciseAccessRule Modifies the accurate access control rule of a website.
DeleteWebPreciseAccessRule Deletes one or more accurate access control rules that are created for a website.
ModifyWebAreaBlockSwitch Enables or disables the Blocked Regions (Domain Names) policy for a website.
DescribeWebAreaBlockConfigs Queries the Blocked Regions (Domain Names) configurations for websites.
ModifyWebAreaBlock Modifies the blocked regions that are configured in the Blocked Regions (Domain Names) policy for a website.
Table 6. Protection policies for non-website services
API Description
DescribePortAutoCcStatus Queries the Intelligent Protection configurations of non-website services.
ModifyPortAutoCcStatus Modifies the Intelligent Protection configuration of a non-website service.
DescribeNetworkRuleAttributes Queries the mitigation settings of the port forwarding rule for a non-website service, which include session persistence and anti-DDoS protection policies.
ModifyNetworkRuleAttribute Modifies the session persistence policy of a port forwarding rule.
Table 7. Custom policies for specific scenarios
API Description
DescribeSceneDefensePolicies Queries details about a scenario-specific custom policy.
CreateSceneDefensePolicy Creates a scenario-specific custom policy.
ModifySceneDefensePolicy Modifies a scenario-specific custom policy.
DeleteSceneDefensePolicy Deletes a scenario-specific custom policy.
DescribeSceneDefenseObjects Queries the protection target of a scenario-specific custom policy.
AttachSceneDefenseObject Attaches a protection target to a scenario-specific custom policy.
DetachSceneDefenseObject Deletes the protection target of a scenario-specific custom policy.
EnableSceneDefensePolicy Enables a scenario-specific custom policy.
DisableSceneDefensePolicy Disables a scenario-specific custom policy.

Monitoring reports

API Description
DescribeDDoSEvents Queries attack events launched against one or more Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribePortFlowList Queries the traffic data of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribePortConnsList Queries the connections established over the ports of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribePortConnsCount Queries the statistics on the connections established over the ports of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribePortMaxConns Queries the maximum number of connections that can be established over the ports of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribePortAttackMaxFlow Queries the peak attack traffic bandwidth and peak attack traffic packet rates of one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specific period of time.
DescribePortViewSourceCountries Queries the countries from which requests are sent to one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specific period of time.
DescribePortViewSourceProvinces Queries the regions inside China from which requests are sent to one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specific period of time.
DescribePortViewSourceIsps Queries the ISPs from which requests are sent to one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specific period of time.
DescribeDomainAttackEvents Queries attack events launched against a website.
DescribeDomainQPSList Queries the statistics on the queries per second (QPS) of a website.
DescribeDomainQpsWithCache Queries the QPS information of a website, such as the total QPS, QPS blocked by different protection policies, and cache hit ratio.
DescribeDomainOverview Queries the attack overview of a website, such as the peak HTTP attack traffic and peak HTTPS attack traffic.
DescribeDomainStatusCodeList Queries the statistics on different response status codes of a website.
DescribeDomainStatusCodeCount Queries the statistics on different response status codes of a website within a specific period of time.
DescribeDomainTopAttackList Queries the peak QPS information of a website, such as the attack QPS and total QPS, within a specific period of time.
DescribeDomainViewSourceCountries Queries the countries from which requests are sent to a website within a specific period of time.
DescribeDomainViewSourceProvinces Queries the regions inside China from which requests are sent to a website within a specific period of time.
DescribeDomainViewTopCostTime Queries the top N URLs that require the longest time to respond to requests within a specific period of time.
DescribeDomainViewTopUrl Queries the top N URLs that receive the most requests within a specific period of time.

Log analysis

API Description
DescribeSlsOpenStatus Queries whether Alibaba Cloud Log Service is activated.
DescribeSlsAuthStatus Checks whether Anti-DDoS Pro or Anti-DDoS Premium is authorized to access Log Service.
DescribeLogStoreExistStatus Checks whether a Logstore is created for Anti-DDoS Pro or Anti-DDoS Premium.
DescribeSlsLogstoreInfo Queries the Logstore information of Anti-DDoS Pro or Anti-DDoS Premium, such as log storage capacity and duration.
ModifyFullLogTtl Modifies the full log storage duration for Anti-DDoS Pro or Anti-DDoS Premium.
DescribeWebAccessLogDispatchStatus Checks whether the Log Analysis feature is enabled for all domain names.
DescribeWebAccessLogStatus Queries the Log Analysis configuration of a single website, such as the feature status and the Log Service project and Logstore that are used.
EnableWebAccessLogConfig Enables the Log Analysis feature for a website.
DisableWebAccessLogConfig Disables the Log Analysis feature for a website.
DescribeWebAccessLogEmptyCount Queries the remaining quota that you can clear the Logstore.
EmptySlsLogstore Clears the Logstore of Anti-DDoS Pro or Anti-DDoS Premium.

Tag management

API Description
DescribeTagKeys Queries all tag keys.
DescribeTagResources Queries the tags bound to resources.
CreateTagResources Binds tags to resources.
DeleteTagResources Unbinds tags from resources.

Static page caching

API Description
DescribeWebCacheConfigs Queries the Static Page Caching configurations of websites.
ModifyWebCacheSwitch Enables or disables the Static Page Caching policy for a website.
ModifyWebCacheMode Modifies the cache mode settings of the Static Page Caching policy for a website.
ModifyWebCacheCustomRule Modifies the custom rule of the Static Page Caching policy for a website.
DeleteWebCacheCustomRule Deletes custom rules of the Static Page Caching policy for a website.

System configurations and logs

API Description
DescribeStsGrantStatus Checks whether Anti-DDoS Pro or Anti-DDoS Premium is authorized to access other cloud services.
DescribeBackSourceCidr Queries the back-to-origin CIDR blocks of Anti-DDoS Pro or Anti-DDoS Premium.
DescribeOpEntities Queries the operations logs of Anti-DDoS Pro.
DescribeDefenseRecords Queries the advanced mitigation logs of Anti-DDoS Premium.
DescribeAsyncTasks Queries details about asynchronous export tasks, such as the task IDs, start time, end time, task status, task parameters, and task results.
CreateAsyncTask Creates an asynchronous export task to export forwarding rules for websites, port forwarding rules, session persistence and health check settings, anti-DDoS protection policies, IP address blacklist, or IP address whitelist.
DeleteAsyncTask Deletes an asynchronous export task.