All Products
Search
Document Center

Anti-DDoS:API overview

Last Updated:Jan 04, 2026

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (ddoscoo/2020-01-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.

Instances

API

Title

Description

ReleaseInstance ReleaseInstance Release an expired Anti-DDoS Proxy instance.
DescribeInstanceIds DescribeInstanceIds Queries the IDs, versions, remarks, and IP type information of Anti-DDoS Proxy instances.
DescribeInstanceStatus DescribeInstanceStatus Queries the status of a specified Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribeInstances DescribeInstances Queries the details of Anti-DDoS Proxy instances.
ModifyElasticBizQps ModifyElasticBizQps Configures the burstable QPS and mode of an Anti-DDoS Proxy instance.

Website configuration

API

Title

Description

CreateWebRule CreateWebRule Creates a forwarding rule for a website.
ModifyWebRule ModifyWebRule Modifies an existing website forwarding rule.
DescribeWebRules DescribeWebRules Queries the configurations of website forwarding rules.
DescribeCerts DescribeCerts Queries all certificates that are available for a domain name. This operation does not query the certificate that is currently in use.
DescribeWebCustomPorts DescribeWebCustomPorts Queries the range of custom ports supported by Anti-DDoS Proxy for website services.
DescribeWebAccessMode DescribeWebAccessMode Queries the access mode of website businesses.
DescribeCnameReuses DescribeCnameReuses Queries the CNAME reuse information about websites.
ConfigL7UsKeepalive ConfigL7UsKeepalive Configures the back-to-origin persistent connection settings for a domain name.
DescribeL7UsKeepalive DescribeL7UsKeepalive Queries the back-to-origin persistent connection settings for a domain name.
DescribeHeaders DescribeHeaders Queries the custom headers for a domain name.
DescribeDomainTopFingerprint DescribeDomainTopFingerprint This operation queries the top N client fingerprints for a website.
DescribeDomainTopHttpMethod DescribeDomainTopHttpMethod Queries the top N HTTP methods for a domain.

Task

API

Title

Description

CreateAsyncTask CreateAsyncTask Creates an asynchronous export task to export website traffic forwarding rules, port forwarding rules, session persistence and health check configurations, DDoS mitigation policies, and IP blacklists and whitelists.

Sec-Traffic manager

API

Title

Description

DescribeSchedulerRules DescribeSchedulerRules Queries the scheduling rules of Sec-Traffic Manager.
DescribeCdnLinkageRules DescribeCdnLinkageRules Describes the CDN interaction rule configurations for a specified domain name.

Protection for infrastructure

API

Title

Description

AddAutoCcBlacklist AddAutoCcBlacklist Adds IP addresses to the blacklist for an Anti-DDoS Pro or Anti-DDoS Premium instance.
AddAutoCcWhitelist AddAutoCcWhitelist Add whitelist IP addresses for an Anti-DDoS Proxy instance.
DescribeBlackholeStatus DescribeBlackholeStatus Queries the blackhole filtering status of an Anti-DDoS Proxy instance.

Protection for website services

API

Title

Description

CreateWebCCRule CreateWebCCRule Creates a custom rule for website HTTP flood protection (CC protection).
EnableWebCCRule EnableWebCCRule Enables a custom HTTP flood protection rule.
ModifyWebCCRule ModifyWebCCRule Modifies a custom rule for website business frequency control protection (HTTP flood protection).
ModifyWebAreaBlockSwitch ModifyWebAreaBlockSwitch Sets the status of the Location Blacklist feature for website services (for domain names).
ModifyWebAreaBlock ModifyWebAreaBlock Configures blocked regions for website domain name blacklists.
DescribeWebAreaBlockConfigs DescribeWebAreaBlockConfigs Queries the configuration information of the Location Blacklist feature (for domain names) in website services.
ConfigWebIpSet ConfigWebIpSet Configures the IP blacklist and whitelist for a website.
ConfigWebCCTemplate ConfigWebCCTemplate Sets the defense mode for website HTTP flood protection (CC protection).
DescribeWebCCRulesV2 DescribeWebCCRulesV2 Queries the custom rules for website frequency control protection (HTTP flood protection).
ConfigWebCCRuleV2 ConfigWebCCRuleV2 Creates or modifies custom rules for website frequency control protection (HTTP flood protection).
ConfigL7GlobalRule ConfigL7GlobalRule Configures the Anti-DDoS Global Mitigation Policy.
DescribeL7GlobalRule DescribeL7GlobalRule Queries the Anti-DDoS Global Mitigation Policy.

Protection for non-website services

API

Title

Description

DescribeNetworkRuleAttributes DescribeNetworkRuleAttributes Queries the mitigation settings of port forwarding rules for non-website services, including session persistence and DDoS mitigation policies.

Custom policies

API

Title

Description

DisableSceneDefensePolicy DisableSceneDefensePolicy Disables a scenario-specific policy.

Attack analysis

API

Title

Description

DescribeDDosEventArea DescribeDDosEventArea Queries the source region from which a volumetric attack is initiated.
DescribeDDosEventIsp DescribeDDosEventIsp Queries the Internet service provider (ISP) information about a volumetric attack.
DescribeDDosAllEventList DescribeDDosAllEventList Queries a list of DDoS attack events.
DescribeAttackAnalysisMaxQps DescribeAttackAnalysisMaxQps Queries the peak value (QPS) of DDoS attacks within a specified time period.

Monitoring reports

API

Title

Description

DescribePortFlowList DescribePortFlowList Queries the traffic data list of an Anti-DDoS Proxy instance.
DescribeDomainStatusCodeList DescribeDomainStatusCodeList Queries the statistics on HTTP status codes of a website.
DescribeDomainStatusCodeCount DescribeDomainStatusCodeCount Queries the statistics on HTTP status codes of a website within a specified period.
DescribeDomainTopAttackList DescribeDomainTopAttackList Queries the peak queries per second (QPS) information about a website, such as the attack QPS and total QPS, within a specific period of time.

Log analysis

API

Title

Description

DescribeDefenseRecords DescribeDefenseRecords Queries the advanced mitigation logs of Anti-DDoS Premium.
EmptySlsLogstore EmptySlsLogstore Deletes the Logstore of Anti-DDoS Proxy.

System configuration and logs

API

Title

Description

DescribeStsGrantStatus DescribeStsGrantStatus Queries whether Anti-DDoS Proxy are authorized to access other cloud services.
DescribeAsyncTasks DescribeAsyncTasks Queries detailed information about asynchronous export tasks, including task ID, start and end times, status, parameters, results, and more.
DescribeSystemLog DescribeSystemLog Queries the billing details of burstable clean bandwidth.

Tag

API

Title

Description

DeleteTagResources DeleteTagResources Removes tags from an Anti-DDoS Proxy (Chinese Mainland) instance.

Port

API

Title

Description

ModifyPort ModifyPort Modifies a port forwarding rule.

Other

API

Title

Description

DeleteDomainResource DeleteDomainResource Deletes the specified website business forwarding rule.

Others

API

Title

Description

AssociateWebCert AssociateWebCert Associates an SSL certificate with the forwarding rule of a website.
AttachSceneDefenseObject AttachSceneDefenseObject Adds an object to a scenario-specific custom policy for protection.
ConfigDomainSecurityProfile ConfigDomainSecurityProfile Configures the global mitigation policy feature, including the feature status and settings.
ConfigL7RsPolicy ConfigL7RsPolicy Configures a back-to-origin policy for the forwarding rule of a website.
ConfigLayer4Remark ConfigLayer4Remark Adds a description to a port forwarding rule.
ConfigLayer4RuleBakMode ConfigLayer4RuleBakMode Enables or disables the origin redundancy mode for a port forwarding rule.
ConfigLayer4RulePolicy ConfigLayer4RulePolicy Configures the IP addresses of the primary and secondary origin servers for a port forwarding rule.
ConfigNetworkRegionBlock ConfigNetworkRegionBlock Configures blocked locations for an Anti-DDoS Proxy instance.
ConfigNetworkRules ConfigNetworkRules Modifies the IP addresses of the origin server that is configured in a port forwarding rule.
ConfigUdpReflect ConfigUdpReflect Adds the filtering policies for UDP reflection attacks on an Anti-DDoS Pro or Anti-DDoS Premium instance to filter out the source ports of UDP traffic.
CreateDomainResource CreateDomainResource Creates a forwarding rule for a website.
CreateNetworkRules CreateNetworkRules Creates a port forwarding rule.
CreatePort CreatePort Creates a port forwarding rule.
CreateSceneDefensePolicy CreateSceneDefensePolicy Creates a scenario-specific custom policy.
CreateSchedulerRule CreateSchedulerRule Creates a scheduling rule for Sec-Traffic Manager.
CreateTagResources CreateTagResources Adds tags to multiple Anti-DDoS Proxy instances at a time.
DeleteAsyncTask DeleteAsyncTask Deletes an asynchronous export task.
DeleteAutoCcBlacklist DeleteAutoCcBlacklist Removes IP addresses from the blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
DeleteAutoCcWhitelist DeleteAutoCcWhitelist Removes IP addresses from the IP address whitelist of an Anti-DDoS Proxy instance.
DeleteNetworkRule DeleteNetworkRule Deletes a port forwarding rule. You can delete only one port forwarding rule at a time.
DeletePort DeletePort Deletes the specified port forwarding rule.
DeleteSceneDefensePolicy DeleteSceneDefensePolicy Deletes a scenario-specific custom policy.
DeleteSchedulerRule DeleteSchedulerRule Deletes a scheduling rule of Sec-Traffic Manager.
DeleteWebCCRule DeleteWebCCRule Deletes a custom frequency control rule of a website.
DeleteWebCCRuleV2 DeleteWebCCRuleV2 Deletes custom frequency control rules of a website.
DeleteWebCacheCustomRule DeleteWebCacheCustomRule Deletes the custom rules of the Static Page Caching policy for a website.
DeleteWebPreciseAccessRule DeleteWebPreciseAccessRule Deletes the accurate access control rules that are created for a website.
DeleteWebRule DeleteWebRule Deletes a forwarding rule of a website.
DescribeAutoCcBlacklist DescribeAutoCcBlacklist Queries the blacklisted IP addresses for an Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribeAutoCcListCount DescribeAutoCcListCount Queries the numbers of IP addresses in the IP address whitelist and IP address blacklist of an Anti-DDoS Proxy instance.
DescribeAutoCcWhitelist DescribeAutoCcWhitelist Queries IP addresses in the IP address whitelist of an Anti-DDoS Proxy instance.
DescribeBackSourceCidr DescribeBackSourceCidr Queries the back-to-origin CIDR blocks of Anti-DDoS Proxy.
DescribeBlockStatus DescribeBlockStatus Queries the Diversion from Origin Server configurations of one or more Anti-DDoS Proxy (Chinese Mainland) instances.
DescribeDDoSEvents DescribeDDoSEvents Queries attack events on Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribeDDosEventAttackType DescribeDDosEventAttackType Queries the attack type details of a volumetric attack.
DescribeDDosEventMax DescribeDDosEventMax Queries the peaks of volumetric attacks (bit/s), connection flood attacks (CPS), and resource exhaustion attacks on websites (QPS).
DescribeDDosEventSrcIp DescribeDDosEventSrcIp Queries the source IP address from which a volumetric attack is initiated.
DescribeDefenseCountStatistics DescribeDefenseCountStatistics Queries the statistics on advanced mitigation sessions of an Anti-DDoS Proxy (Outside Chinese Mainland) instance.
DescribeDestinationPortEvent DescribeDestinationPortEvent Queries the number of request packets received by the destination ports of the attacked IP address that is protected by Anti-DDoS Proxy.
DescribeDomainAttackEvents DescribeDomainAttackEvents Queries the attack events launched against a website.
DescribeDomainBps DescribeDomainBps Queries the bandwidths of a website.
DescribeDomainH2Fingerprint DescribeDomainH2Fingerprint Queries the information about HTTP/2 fingerprints of a website.
DescribeDomainOverview DescribeDomainOverview Queries the attack overview of a website, such as the peak HTTP and HTTPS traffic.
DescribeDomainQPSList DescribeDomainQPSList Queries the statistics on the queries per second (QPS) of a website.
DescribeDomainResource DescribeDomainResource Queries the configurations of a forwarding rule.
DescribeDomainTopReferer DescribeDomainTopReferer Queries the information about top N referers of a website.
DescribeDomainTopUserAgent DescribeDomainTopUserAgent Queries the information about top user agents of a website.
DescribeDomainViewSourceCountries DescribeDomainViewSourceCountries Queries the areas and countries from which requests are sent to a website within a specified period of time.
DescribeDomainViewSourceProvinces DescribeDomainViewSourceProvinces Queries the administrative regions in China from which requests are sent to a website within a specified period of time.
DescribeDomainViewTopCostTime DescribeDomainViewTopCostTime Queries the top N URLs that require the longest time to respond to requests within a specified period of time.
DescribeDomainViewTopUrl DescribeDomainViewTopUrl Queries the top N URLs that receive the most requests for a website within a specified time period.
DescribeDomains DescribeDomains Queries domain names for which forwarding rules are created.
DescribeElasticBandwidthSpec DescribeElasticBandwidthSpec Queries the available burstable protection bandwidths of an Anti-DDoS Proxy (Chinese Mainland) instance.
DescribeElasticQps DescribeElasticQps Queries the line chart of the bills for the burstable QPS of an Anti-DDoS Proxy instance.
DescribeElasticQpsRecord DescribeElasticQpsRecord Queries the burstable QPS details of an Anti-DDoS Proxy instance.
DescribeHealthCheckList DescribeHealthCheckList Queries the Layer 4 or Layer 7 health check configurations of a port forwarding rule.
DescribeHealthCheckStatus DescribeHealthCheckStatus Queries the health status of an origin server.
DescribeInstanceDetails DescribeInstanceDetails Queries the IP addresses and Internet service provider (ISP) lines of Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribeInstanceExt DescribeInstanceExt Queries the information about Anti-DDoS Pro and Anti-DDoS Premium instances.
DescribeInstanceSpecs DescribeInstanceSpecs Queries the specifications of Anti-DDoS Pro or Anti-DDoS Premium instances.
DescribeInstanceStatistics DescribeInstanceStatistics Queries the statistics on one or more Anti-DDoS Proxy instances, such as the numbers of protected domain names and ports.
DescribeL7RsPolicy DescribeL7RsPolicy Queries the back-to-origin policies for the forwarding rule of a website.
DescribeLayer4RulePolicy DescribeLayer4RulePolicy Queries the back-to-origin settings of a port forwarding rule.
DescribeLogStoreExistStatus DescribeLogStoreExistStatus Checks whether a Logstore is created for Anti-DDoS Proxy.
DescribeNetworkRegionBlock DescribeNetworkRegionBlock Queries the blocked locations that are configured for an Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribeNetworkRules DescribeNetworkRules Queries port forwarding rules.
DescribeOpEntities DescribeOpEntities Queries the operation logs of Anti-DDoS Proxy (Chinese Mainland).
DescribePort DescribePort Queries the port forwarding rules that are created for an Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribePortAttackMaxFlow 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 specified period of time.
DescribePortAutoCcStatus DescribePortAutoCcStatus Queries the configurations of the Intelligent Protection policy for non-website services.
DescribePortConnsCount DescribePortConnsCount The statistics on the connections established over the ports of one or more Anti-DDoS Pro or Anti-DDoS Premium instances are queried.
DescribePortConnsList DescribePortConnsList Queries the connections established over the ports of one or more Anti-DDoS Proxy instances.
DescribePortMaxConns DescribePortMaxConns Queries the maximum number of connections that can be established over the ports of one or more Anti-DDoS Proxy instances.
DescribePortViewSourceCountries DescribePortViewSourceCountries Queries the areas and countries from which requests are sent to one or more Anti-DDoS Pro or Anti-DDoS Premium instances within the specified period of time.
DescribePortViewSourceIsps DescribePortViewSourceIsps Queries the Internet service providers (ISPs) from which requests are sent to one or more Anti-DDoS Pro or Anti-DDoS Premium instances within the specified period of time.
DescribePortViewSourceProvinces DescribePortViewSourceProvinces Queries the administrative regions in China from which requests are sent to one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specified period of time.
DescribeSceneDefenseObjects DescribeSceneDefenseObjects Queries the protected objects of a scenario-specific custom policy.
DescribeSceneDefensePolicies DescribeSceneDefensePolicies Queries the configurations of a scenario-specific custom policy.
DescribeSlaEventList DescribeSlaEventList Queries the destination rate limit events.
DescribeSlsAuthStatus DescribeSlsAuthStatus Queries whether Anti-DDoS Proxy is authorized to access Simple Log Service.
DescribeSlsLogstoreInfo DescribeSlsLogstoreInfo Queries information about the Logstore of the Anti-DDoS Proxy instance, such as the log storage capacity and log storage duration.
DescribeSlsOpenStatus DescribeSlsOpenStatus Checks whether Simple Log Service is activated.
DescribeTagKeys DescribeTagKeys Queries all tag keys and the number of Anti-DDoS Proxy (Chinese Mainland) instances to which each tag key is added.
DescribeTagResources DescribeTagResources Queries the information about the tags that are added to an Anti-DDoS Proxy (Chinese Mainland) instance.
DescribeUdpReflect DescribeUdpReflect Queries the source ports of UDP traffic that are filtered out by the filtering policies for UDP reflection attacks on an Anti-DDoS Pro or Anti-DDoS Premium instance.
DescribeUnBlackholeCount DescribeUnBlackholeCount Queries the total quota and remaining quota for blackhole filtering deactivation.
DescribeUnBlockCount DescribeUnBlockCount Queries the total number and the remaining number of times that you can enable the near-origin traffic diversion feature.
DescribeWebAccessLogDispatchStatus DescribeWebAccessLogDispatchStatus Checks whether the log analysis feature is enabled for all domain names.
DescribeWebAccessLogEmptyCount DescribeWebAccessLogEmptyCount Queries the remaining quota that allows you to clear the Logstore.
DescribeWebAccessLogStatus DescribeWebAccessLogStatus Queries the information about the log analysis feature for a website, such as the feature status and the Simple Log Service project and Logstore that are used.
DescribeWebCCRules DescribeWebCCRules Queries the custom frequency control rules that are created for a website.
DescribeWebCacheConfigs DescribeWebCacheConfigs Queries the Static Page Caching configuration of websites.
DescribeWebCcProtectSwitch DescribeWebCcProtectSwitch Queries the status of protection features for your web services.
DescribeWebInstanceRelations DescribeWebInstanceRelations Queries the information about Anti-DDoS Pro or Anti-DDoS Premium instances to which a website service is added.
DescribeWebPreciseAccessRule DescribeWebPreciseAccessRule Queries the precise access control rules for a website.
DetachSceneDefenseObject DetachSceneDefenseObject Removes a protected object from a scenario-specific custom policy.
DisableWebAccessLogConfig DisableWebAccessLogConfig Disables the log analysis feature for a website.
DisableWebCC DisableWebCC Disables frequency control for a website.
DisableWebCCRule DisableWebCCRule Disables custom frequency control rules for a website.
EmptyAutoCcBlacklist EmptyAutoCcBlacklist Clears the IP address blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
EmptyAutoCcWhitelist EmptyAutoCcWhitelist Clears the IP address whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance.
EnableSceneDefensePolicy EnableSceneDefensePolicy Enables a scenario-specific custom policy.
EnableWebAccessLogConfig EnableWebAccessLogConfig Enables the log analysis feature for a website.
EnableWebCC EnableWebCC Enables the Frequency Control policy for a website.
ModifyBlackholeStatus ModifyBlackholeStatus Deactivates blackhole filtering that is triggered on an instance.
ModifyBlockStatus ModifyBlockStatus Modifies the Diversion from Origin Server configuration of an Anti-DDoS Proxy (Chinese Mainland) instance.
ModifyCnameReuse ModifyCnameReuse Enables or disables CNAME reuse for a website.
ModifyDomainResource ModifyDomainResource Modifies the forwarding rule of a website.
ModifyElasticBandWidth ModifyElasticBandWidth Modifies the burstable protection bandwidth of a specified Anti-DDoS Proxy (Chinese Mainland) instance.
ModifyFullLogTtl ModifyFullLogTtl Modifies the log storage duration for Anti-DDoS Proxy.
ModifyHeaders ModifyHeaders Modifies the custom header of a domain name that is added to an Anti-DDoS Pro or Anti-DDoS Premium instance.
ModifyHealthCheckConfig ModifyHealthCheckConfig Modifies the Layer 4 or Layer 7 health check configuration of a port forwarding rule.
ModifyHttp2Enable ModifyHttp2Enable Enables or disables HTTP/2 for the forwarding rule of a website.
ModifyInstance ModifyInstance Instance adjustment, similar to BSS adjustment
ModifyInstanceRemark ModifyInstanceRemark Modifies the description of an Anti-DDoS Proxy instance.
ModifyNetworkRuleAttribute ModifyNetworkRuleAttribute Modifies the session persistence and DDoS mitigation policy settings for a port forwarding rule.
ModifyOcspStatus ModifyOcspStatus Specifies whether to enable the Online Certificate Status Protocol (OCSP) feature.
ModifyPortAutoCcStatus ModifyPortAutoCcStatus Modifies the Intelligent Protection configuration of a non-website service.
ModifyQpsMode ModifyQpsMode Switches between the metering methods of the burstable clean bandwidth feature.
ModifySceneDefensePolicy ModifySceneDefensePolicy Modifies a scenario-specific custom policy.
ModifySchedulerRule ModifySchedulerRule Modifies the scheduling rule of Sec-Traffic Manager.
ModifyTlsConfig ModifyTlsConfig Modifies the Transport Layer Security (TLS) policy configuration for the forwarding rule of a website.
ModifyWebAIProtectMode ModifyWebAIProtectMode Changes the mode of the intelligent protection feature for a website.
ModifyWebAIProtectSwitch ModifyWebAIProtectSwitch Enables or disables the Intelligent Protection policy for a website.
ModifyWebAccessMode ModifyWebAccessMode Changes the mode in which a website service is added to Anti-DDoS Pro or Anti-DDoS Premium.
ModifyWebCCGlobalSwitch ModifyWebCCGlobalSwitch Enables or disables the HTTP flood mitigation feature for a website.
ModifyWebCacheCustomRule ModifyWebCacheCustomRule Modifies the custom rule of the Static Page Caching policy for a website.
ModifyWebCacheMode ModifyWebCacheMode Changes the cache mode of the Static Page Caching policy for a website.
ModifyWebCacheSwitch ModifyWebCacheSwitch Enables or disables the Static Page Caching policy for a website.
ModifyWebIpSetSwitch ModifyWebIpSetSwitch Enables or disables the Black Lists and White Lists (Domain Names) policy for a domain name.
ModifyWebPreciseAccessRule ModifyWebPreciseAccessRule Creates or modifies an accurate access control rule of a website.
ModifyWebPreciseAccessSwitch ModifyWebPreciseAccessSwitch Enables or disables accurate access control for a website.
SwitchSchedulerRule SwitchSchedulerRule Switches service traffic to an Anti-DDoS Pro or Anti-DDoS Premium instance for scrubbing or switches service traffic back to the associated cloud resources.