The following tables list API operations available for use in Anti-DDoS Pro and Anti-DDoS Premium.
Notice Operations described in this topic apply only to Anti-DDoS Pro and Anti-DDoS Premium.
- Before you call the following operations, make sure that you have purchased an Anti-DDoS
Pro or Anti-DDoS Premium instance.
For more information, see Purchase mitigation plans for Anti-DDoS Pro and Anti-DDoS Premium.
- Unless otherwise specified, the following operations apply to both Anti-DDoS Pro and
Anti-DDoS Premium. If some operations apply to only one of them, extra descriptions
are provided.
For more information about the differences between Anti-DDoS Pro and Anti-DDoS Premium, see Differences between the features of Anti-DDoS Pro and Anti-DDoS Premium.
- For more information, visit OpenAPI Explorer.
Instances
| Operation | Description |
|---|---|
| DescribeInstanceIds | Queries the IDs of all Anti-DDoS Pro or Anti-DDoS Premium instances. |
| DescribeInstances | Queries the detailed information about one or more Anti-DDoS Pro or Anti-DDoS Premium instances, such as traffic forwarding status, expiration status, and overdue payment status. |
| DescribeInstanceStatus | Queries the status of a specified Anti-DDoS Pro or Anti-DDoS Premium instance. The status includes normal, expired, overdue, and released. |
| DescribeInstanceDetails | Queries the IP addresses and Internet service provider (ISP) line information about one or more specified Anti-DDoS Pro or Anti-DDoS Premium instances. |
| DescribeInstanceSpecs | Queries the specifications of one or more specified Anti-DDoS Pro or Anti-DDoS Premium instances. |
| DescribeInstanceStatistics | Queries the statistics on one or more specified 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 a specified Anti-DDoS Pro instance. |
| ModifyElasticBandWidth | Modifies the burstable protection bandwidth of a specified Anti-DDoS Pro instance. |
| DescribeDefenseCountStatistics | Queries the information about 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. |
Website configuration
| Operation | Description |
|---|---|
| DescribeDomains | Queries the domain names that are added to one or more Anti-DDoS Pro or Anti-DDoS Premium instances. |
| 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 about Anti-DDoS Pro or Anti-DDoS Premium instances to which the websites are added. |
| 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 about a website. |
| DescribeCnameReuses | Queries the CNAME reuse information about a website. |
| ModifyCnameReuse | Enables or disables CNAME reuse for a website. |
| ModifyHttp2Enable | Enables or disables HTTP/2 for the forwarding rule of a website. |
| DescribeL7RsPolicy | Queries the back-to-origin policies for the forwarding rule of a website. |
| ConfigL7RsPolicy | Configures a back-to-origin policy for the forwarding rule of a website. |
Port configuration
| Operation | 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 configurations of a port forwarding rule. |
| ModifyHealthCheckConfig | Modifies the Layer 4 or Layer 7 health check configurations of a port forwarding rule. |
| DescribeHealthCheckStatus | Queries the health status of an origin server. |
Sec-Traffic Manager
| Operation | 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 for infrastructure
| Operation | 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 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 the whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance. |
| DescribeUnBlackholeCount | Queries the total and remaining quotas that you can deactivate blackhole filtering. |
| DescribeBlackholeStatus | Queries the blackhole filtering status of one or more Anti-DDoS Pro or Anti-DDoS Premium instances. |
| ModifyBlackholeStatus | Deactivates blackhole filtering. |
| 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 configurations of an Anti-DDoS Pro instances. |
| DescribeUnBlockCount | Queries the remaining quota that you can use the Diversion from Origin Server policy. |
Protection for website services
| Operation | 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 | Modifies the settings of the Frequency Control policy for a website. |
| EnableWebCCRule | Turns on Custom Rule of the Frequency Control policy for a website. |
| DisableWebCCRule | Turns off Custom Rule 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 rules that are created for a website. |
| DeleteWebPreciseAccessRule | Deletes the 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. |
Protection for non-website services
| Operation | Description |
|---|---|
| DescribePortAutoCcStatus | Queries the Intelligent Protection configurations for non-website services. |
| ModifyPortAutoCcStatus | Modifies the Intelligent Protection configurations for non-website services. |
| DescribeNetworkRuleAttributes | Queries the mitigation settings of the port forwarding rule for a non-website service. The mitigation settings include session persistence and DDoS mitigation policies. |
| ModifyNetworkRuleAttribute | Modifies the session persistence policy of the port forwarding rule for a non-website service. |
Scenario-specific policies
| Operation | Description |
|---|---|
| DescribeSceneDefensePolicies | Queries details about scenario-specific policies. |
| 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 objects of a scenario-specific custom policy. |
| AttachSceneDefenseObject | Adds a protection object to a scenario-specific custom policy. |
| DetachSceneDefenseObject | Removes a protection object from a scenario-specific custom policy. |
| EnableSceneDefensePolicy | Enables a scenario-specific custom policy. |
| DisableSceneDefensePolicy | Disables a scenario-specific custom policy. |
Attack analysis
| Operation | Description |
|---|---|
| DescribeDDosEventMax | Queries the peaks of volumetric attacks (bit/s), connection flood attacks (CPS), and resource exhaustion attacks on websites (QPS) within a specific period. |
| DescribeDDosAllEventList | Queries attack events. |
| DescribeDDosEventArea | Queries source regions from which a volumetric attack is initiated. |
| DescribeDDosEventAttackType | Queries the details of a volumetric attack type. |
| DescribeDDosEventIsp | Queries the ISP of a volumetric attack. |
| DescribeDDosEventSrcIp | Queries the source IP addresses from which a volumetric attack is initiated. |
Monitoring reports
| Operation | Description |
|---|---|
| DescribeDDoSEvents | Queries the 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 bandwidth and peak packet rates of attack traffic on one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specific period. |
| DescribePortViewSourceCountries | Queries the areas and countries from which requests are sent to one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specific period. |
| DescribePortViewSourceProvinces | Queries the administrative regions inside China from which requests are sent to one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specific period. |
| 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. |
| DescribeDomainAttackEvents | Queries the attack events launched against a website. |
| DescribeDomainQPSList | Queries the statistics on the queries per second (QPS) of a website. |
| DescribeDomainQpsWithCache | Queries the QPS information about a website, such as the total QPS, QPS when protection policies are triggered, and cache hit ratio. |
| DescribeDomainOverview | Queries the attack overview of a website, such as the peak traffic of HTTP and HTTPS traffic. |
| DescribeDomainStatusCodeList | Queries the statistics on response status codes of a website. |
| DescribeDomainStatusCodeCount | Queries the statistics on response status codes of a website within a specific period. |
| DescribeDomainTopAttackList | Queries the peak QPS information about a website, such as the attack QPS and total QPS, within a specific period. |
| DescribeDomainViewSourceCountries | Queries the areas and countries from which requests are sent to a website within a specific period. |
| DescribeDomainViewSourceProvinces | Queries the administrative regions inside China from which requests are sent to a website within a specific period. |
| DescribeDomainViewTopCostTime | Queries the top N URLs that require the longest time to respond to requests within a specific period. |
| DescribeDomainViewTopUrl | Queries the top N URLs that receive the most requests within a specific period. |
Log analysis
| Operation | Description |
|---|---|
| DescribeSlsOpenStatus | Checks 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 about Anti-DDoS Pro or Anti-DDoS Premium, such as the 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 information about the Log Analysis feature for a 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
| Operation | Description |
|---|---|
| DescribeTagKeys | Queries all tag keys. |
| DescribeTagResources | Queries the tags that are bound to resources. |
| CreateTagResources | Binds tags to resources. |
| DeleteTagResources | Unbinds tags from resources. |
Static page caching
| Operation | 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 the custom rules of the Static Page Caching policy for a website. |
System configurations and logs
| Operation | Description |
|---|---|
| DescribeStsGrantStatus | Checks whether Anti-DDoS Pro or Anti-DDoS Premium is authorized to access other cloud services. |
| DescribeBackSourceCidr | Queries the back-to-origin Classless Inter-Domain Routing (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 IDs, start time, end time, status, parameters, and results. |
| CreateAsyncTask | Creates an asynchronous export task to export business forwarding rules for websites, port forwarding rules, session persistence and health check configurations, DDoS mitigation policies, the IP address blacklist, or the IP address whitelist. |
| DeleteAsyncTask | Deletes an asynchronous export task. |