This product(
ddoscoo/2020-01-01) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Instances
| API | Title | Description |
|---|---|---|
| ReleaseInstance | ReleaseInstance | Releases an expired Anti-DDoS Pro or Anti-DDoS Premium instance. |
| ModifyInstanceRemark | ModifyInstanceRemark | Modifies the description of an Anti-DDoS Pro or Anti-DDoS Premium instance. |
| ModifyElasticBandWidth | ModifyElasticBandWidth | Modifies the burstable protection bandwidth of a specified Anti-DDoS Proxy (Chinese Mainland) instance. |
| DescribeInstanceIds | DescribeInstanceIds | The description of the instance. |
| DescribeInstanceStatus | DescribeInstanceStatus | Queries the status of a specified Anti-DDoS Proxy instance. |
| DescribeElasticBandwidthSpec | DescribeElasticBandwidthSpec | Queries the available burstable protection bandwidths of an Anti-DDoS Pro instance. |
| DescribeInstanceStatistics | DescribeInstanceStatistics | Queries the statistics on one or more Anti-DDoS Proxy instances, such as the numbers of protected domain names and ports. |
| DescribeInstances | DescribeInstances | |
| DescribeInstanceSpecs | DescribeInstanceSpecs | Queries the specifications of Anti-DDoS Pro or Anti-DDoS Premium instances. |
| DescribeInstanceDetails | DescribeInstanceDetails | Queries the IP addresses and Internet service provider (ISP) lines of Anti-DDoS Pro or Anti-DDoS Premium instances. |
Website configuration
| API | Title | Description |
|---|---|---|
| CreateWebRule | CreateWebRule | Creates a forwarding rule for a website. |
| DeleteWebRule | DeleteWebRule | Deletes a forwarding rule of a website. |
| ModifyWebRule | ModifyWebRule | Modifies the forwarding rule of a website. |
| ModifyTlsConfig | ModifyTlsConfig | Modifies the Transport Layer Security (TLS) policy configuration for the forwarding rule of a website. |
| ModifyHttp2Enable | ModifyHttp2Enable | Enables or disables HTTP/2 for the forwarding rule of a website. |
| ModifyWebAccessMode | ModifyWebAccessMode | Changes the mode in which a website service is added to Anti-DDoS Pro or Anti-DDoS Premium. |
| ModifyCnameReuse | ModifyCnameReuse | Enables or disables CNAME reuse for a website. |
| DescribeWebRules | DescribeWebRules | Indicates whether Allow Access Only from SM Certificates-based Clients is turned on. \* 0: no \* 1: yes |
| DescribeWebInstanceRelations | DescribeWebInstanceRelations | Queries the information about Anti-DDoS Pro or Anti-DDoS Premium instances to which a website service is added. |
| DescribeCerts | DescribeCerts | Queries information about all certificates that can be associated with the current domain name instead of the certificate currently in use. To query the information about the certificate that is currently in use, you can call the DescribeWebRules operation and view the values of the CertName and CertRegion response parameters. |
| DescribeWebCustomPorts | DescribeWebCustomPorts | Queries the supported custom ports of a website. |
| DescribeWebAccessMode | DescribeWebAccessMode | Queries the mode in which a website service is added to Anti-DDoS Pro or Anti-DDoS Premium. |
| DescribeCnameReuses | DescribeCnameReuses | Queries the CNAME reuse information about websites. |
| DescribeL7RsPolicy | DescribeL7RsPolicy | Queries the back-to-origin policies for the forwarding rule of a website. |
| AssociateWebCert | AssociateWebCert | Associates an SSL certificate with the forwarding rule of a website. |
| ConfigL7RsPolicy | ConfigL7RsPolicy | Configures a back-to-origin policy for the forwarding rule of a website. |
| ModifyOcspStatus | ModifyOcspStatus | Specifies whether to enable the Online Certificate Status Protocol (OCSP) feature. |
Task
| API | Title | Description |
|---|---|---|
| CreateAsyncTask | CreateAsyncTask | Creates an asynchronous export task to export forwarding rules for websites, port forwarding rules, session persistence and health check settings, DDoS mitigation policies, the IP address blacklist, or the IP address whitelist. |
| DeleteAsyncTask | DeleteAsyncTask | Deletes an asynchronous export task. |
Network forwarding rules
| API | Title | Description |
|---|---|---|
| CreateNetworkRules | CreateNetworkRules | Creates a port forwarding rule. |
| DeleteNetworkRule | DeleteNetworkRule | Deletes a port forwarding rule. You can delete only one port forwarding rule at a time. |
| ModifyHealthCheckConfig | ModifyHealthCheckConfig | Modifies the Layer 4 or Layer 7 health check configuration of a port forwarding rule. |
| DescribeNetworkRules | DescribeNetworkRules | Queries port forwarding rules. |
| DescribeHealthCheckStatus | DescribeHealthCheckStatus | Queries the health status of an origin server. |
| ConfigNetworkRules | ConfigNetworkRules | Modifies the IP addresses of the origin server that is configured in a port forwarding rule. |
Sec-Traffic manager
| API | Title | Description |
|---|---|---|
| CreateSchedulerRule | CreateSchedulerRule | Creates a scheduling rule for Sec-Traffic Manager. |
| DeleteSchedulerRule | DeleteSchedulerRule | Deletes a scheduling rule of Sec-Traffic Manager. |
| ModifySchedulerRule | ModifySchedulerRule | Modifies the scheduling rule of Sec-Traffic Manager. |
| DescribeSchedulerRules | DescribeSchedulerRules | Queries the scheduling rules of Sec-Traffic Manager. |
| SwitchSchedulerRule | SwitchSchedulerRule | Switches service traffic to your Anti-DDoS Pro or Anti-DDoS Premium instance for scrubbing or switches service traffic back to the associated cloud resources. |
Protection for infrastructure
| API | Title | Description |
|---|---|---|
| AddAutoCcBlacklist | AddAutoCcBlacklist | Adds IP addresses to the IP address blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance. |
| AddAutoCcWhitelist | AddAutoCcWhitelist | Adds IP addresses to the IP address whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance. |
| DeleteAutoCcBlacklist | DeleteAutoCcBlacklist | Removes IP addresses from the IP address 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 Pro or Anti-DDoS Premium instance. |
| 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. |
| DescribeAutoCcListCount | DescribeAutoCcListCount | Queries the numbers of IP addresses in the IP address whitelist and IP address blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance. |
| DescribeAutoCcBlacklist | DescribeAutoCcBlacklist | Queries IP addresses in the IP address blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance. |
| DescribeAutoCcWhitelist | DescribeAutoCcWhitelist | Queries IP addresses in the IP address whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance. |
| DescribeUnBlackholeCount | DescribeUnBlackholeCount | Queries the total quota and remaining quota that allow you to deactivate blackhole filtering. |
| DescribeBlackholeStatus | DescribeBlackholeStatus | Queries the blackhole filtering status of one or more Anti-DDoS Pro or Anti-DDoS Premium instances. |
| DescribeNetworkRegionBlock | DescribeNetworkRegionBlock | Queries the blocked locations that are configured for an Anti-DDoS Pro or Anti-DDoS Premium instance. |
| DescribeBlockStatus | DescribeBlockStatus | Queries the Diversion from Origin Server configurations of one or more Anti-DDoS Proxy (Chinese Mainland) instances. |
| DescribeUnBlockCount | DescribeUnBlockCount | Queries the remaining quota that allows you to use the Diversion from Origin Server policy. |
| 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. |
| ConfigNetworkRegionBlock | ConfigNetworkRegionBlock | Configures blocked locations for an Anti-DDoS Pro or Anti-DDoS Premium 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. |
| 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. |
Protection for website services
| API | Title | Description |
|---|---|---|
| CreateWebCCRule | CreateWebCCRule | Creates a custom frequency control rule for a website. |
| DeleteWebCCRule | DeleteWebCCRule | Deletes a custom frequency control rule of a website. |
| DeleteWebPreciseAccessRule | DeleteWebPreciseAccessRule | Deletes the accurate access control rules that are created for a website. |
| ModifyWebAIProtectSwitch | ModifyWebAIProtectSwitch | Enables or disables the Intelligent Protection policy for a website. |
| ModifyWebAIProtectMode | ModifyWebAIProtectMode | Changes the mode of the Intelligent Protection policy for a website. |
| ModifyWebIpSetSwitch | ModifyWebIpSetSwitch | Enables or disables the Black Lists and White Lists (Domain Names) policy for a domain name. |
| EnableWebCC | EnableWebCC | Enables the Frequency Control policy for a website. |
| DisableWebCC | DisableWebCC | Disables the Frequency Control policy for a website. |
| EnableWebCCRule | EnableWebCCRule | Turns on the Custom Rule switch of the Frequency Control policy for a website. |
| DisableWebCCRule | DisableWebCCRule | Turns off the Custom Rule switch of the Frequency Control policy for a website. |
| ModifyWebCCRule | ModifyWebCCRule | Modifies the custom frequency control rule of a website. |
| ModifyWebPreciseAccessSwitch | ModifyWebPreciseAccessSwitch | Enables or disables the Accurate Access Control policy for a website. |
| ModifyWebPreciseAccessRule | ModifyWebPreciseAccessRule | Modifies the accurate access control rule of a website. |
| ModifyWebAreaBlockSwitch | ModifyWebAreaBlockSwitch | Enables or disables the Location Blacklist (Domain Names) policy for a domain name. |
| ModifyWebAreaBlock | ModifyWebAreaBlock | Modifies the blocked locations that are configured in the Location Blacklist (Domain Names) policy for a website. |
| DescribeWebCcProtectSwitch | DescribeWebCcProtectSwitch | Queries the status of each mitigation policy for a website. |
| DescribeWebCCRules | DescribeWebCCRules | Queries the custom frequency control rules that are created for a website. |
| DescribeWebPreciseAccessRule | DescribeWebPreciseAccessRule | Queries the accurate access control rules that are created for websites. |
| DescribeWebAreaBlockConfigs | DescribeWebAreaBlockConfigs | Queries the Location Blacklist (Domain Names) configurations for websites. |
| ConfigWebIpSet | ConfigWebIpSet | Configures the IP address whitelist and blacklist for a website. |
| ConfigWebCCTemplate | ConfigWebCCTemplate | Configures the mode of the Frequency Control policy for a website. |
Protection for non-website services
| API | Title | Description |
|---|---|---|
| ModifyPortAutoCcStatus | ModifyPortAutoCcStatus | Modifies the Intelligent Protection configuration of a non-website service. |
| ModifyNetworkRuleAttribute | ModifyNetworkRuleAttribute | Modifies the session persistence settings of a port forwarding rule. |
| DescribePortAutoCcStatus | DescribePortAutoCcStatus | Queries the configurations of the Intelligent Protection policy for non-website services. |
| DescribeDomains | DescribeDomains | Queries domain names for which forwarding rules are created. |
| DescribeHealthCheckList | DescribeHealthCheckList | Queries the Layer 4 or Layer 7 health check configurations of a port forwarding rule. |
| DescribeNetworkRuleAttributes | 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. |
Custom policies
| API | Title | Description |
|---|---|---|
| CreateSceneDefensePolicy | CreateSceneDefensePolicy | Creates a scenario-specific custom policy. |
| DeleteSceneDefensePolicy | DeleteSceneDefensePolicy | Deletes a scenario-specific custom policy. |
| ModifySceneDefensePolicy | ModifySceneDefensePolicy | Modifies a scenario-specific custom policy. |
| AttachSceneDefenseObject | AttachSceneDefenseObject | Adds an object to a scenario-specific custom policy for protection. |
| DetachSceneDefenseObject | DetachSceneDefenseObject | Removes a protected object from a scenario-specific custom policy. |
| EnableSceneDefensePolicy | EnableSceneDefensePolicy | Enables a scenario-specific custom policy. |
| DisableSceneDefensePolicy | DisableSceneDefensePolicy | Disables a scenario-specific custom policy. |
| DescribeSceneDefensePolicies | DescribeSceneDefensePolicies | Queries the configurations of a scenario-specific custom policy. |
| DescribeSceneDefenseObjects | DescribeSceneDefenseObjects | Queries the protected objects of a scenario-specific custom policy. |
Static page caching
| API | Title | Description |
|---|---|---|
| DeleteWebCacheCustomRule | DeleteWebCacheCustomRule | Deletes the custom rules of the Static Page Caching policy for a website. |
| ModifyWebCacheSwitch | ModifyWebCacheSwitch | Enables or disables the Static Page Caching policy for a website. |
| ModifyWebCacheMode | ModifyWebCacheMode | Changes the cache mode of the Static Page Caching policy for a website. |
| ModifyWebCacheCustomRule | ModifyWebCacheCustomRule | Modifies the custom rule of the Static Page Caching policy for a website. |
| DescribeWebCacheConfigs | DescribeWebCacheConfigs | Queries the Static Page Caching configuration of websites. |
Attack analysis
| API | Title | Description |
|---|---|---|
| DescribeDDosEventMax | DescribeDDosEventMax | Queries the peaks of volumetric attacks (bit/s), connection flood attacks (CPS), and resource exhaustion attacks on websites (QPS). |
| DescribeDDosEventArea | DescribeDDosEventArea | Queries the source region from which a volumetric attack is initiated. |
| DescribeDDosEventAttackType | DescribeDDosEventAttackType | Queries the attack type details of a volumetric attack. |
| DescribeDDosEventIsp | DescribeDDosEventIsp | Queries the Internet service provider (ISP) information about a volumetric attack. |
| DescribeDDosEventSrcIp | DescribeDDosEventSrcIp | Queries the source IP address from which a volumetric attack is initiated. |
| DescribeBackSourceCidr | DescribeBackSourceCidr | Queries the back-to-origin CIDR blocks of Anti-DDoS Pro or Anti-DDoS Premium. |
| DescribeDDosAllEventList | DescribeDDosAllEventList | Query DDoS attacks by IP address. |
| DescribeDDoSEvents | DescribeDDoSEvents | Queries the attack events launched against one or more Anti-DDoS Pro or Anti-DDoS Premium instances. |
| DescribeSlaEventList | DescribeSlaEventList | Queries the destination rate limit events. |
| DescribeDomainAttackEvents | DescribeDomainAttackEvents | Queries the attack events launched against a website. |
| DescribeDefenseCountStatistics | DescribeDefenseCountStatistics | Queries the statistics on advanced mitigation sessions of an Anti-DDoS Proxy (Outside Chinese Mainland) instance. |
| DescribeAttackAnalysisMaxQps | DescribeAttackAnalysisMaxQps | Queries the peak QPS of DDoS attacks within the specific period of time. |
Monitoring reports
| API | Title | Description |
|---|---|---|
| DescribePortFlowList | DescribePortFlowList | Queries the traffic data of one or more Anti-DDoS Pro or Anti-DDoS Premium instances. |
| DescribePortConnsList | DescribePortConnsList | Queries the connections established over the ports of one or more Anti-DDoS Proxy instances. |
| 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. |
| DescribePortMaxConns | 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 | 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. |
| 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. |
| DescribeDomainQPSList | DescribeDomainQPSList | Queries the statistics on the queries per second (QPS) of a website. |
| DescribeDomainStatusCodeList | DescribeDomainStatusCodeList | Queries the statistics on HTTP status codes of a website. |
| DescribeDomainOverview | DescribeDomainOverview | Queries the attack overview of a website, such as the peak HTTP and HTTPS traffic. |
| DescribeDomainStatusCodeCount | DescribeDomainStatusCodeCount | Queries the statistics on HTTP status codes of a website within a specified period of time. |
| 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. |
| 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 within a specified period of time. |
Log analysis
| API | Title | Description |
|---|---|---|
| EnableWebAccessLogConfig | EnableWebAccessLogConfig | Enables the log analysis feature for a website. |
| ModifyFullLogTtl | ModifyFullLogTtl | Modifies the log storage duration for Anti-DDoS Pro or Anti-DDoS Premium. |
| DisableWebAccessLogConfig | DisableWebAccessLogConfig | Disables the log analysis feature for a website. |
| DescribeWebAccessLogDispatchStatus | DescribeWebAccessLogDispatchStatus | Checks whether the log analysis feature is enabled for all domain names. |
| DescribeWebAccessLogStatus | 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. |
| DescribeLogStoreExistStatus | DescribeLogStoreExistStatus | Checks whether a Logstore is created for Anti-DDoS Pro or Anti-DDoS Premium. |
| DescribeOpEntities | DescribeOpEntities | Queries the operation logs of Anti-DDoS Pro. |
| DescribeSlsAuthStatus | DescribeSlsAuthStatus | Queries whether Anti-DDoS Pro or Anti-DDoS Premium is authorized to access Log Service. |
| DescribeSlsLogstoreInfo | DescribeSlsLogstoreInfo | Queries the information about the Logstore of the Anti-DDoS Pro or Anti-DDoS Premium instance, such as the log storage capacity and log storage duration. |
| DescribeSlsOpenStatus | DescribeSlsOpenStatus | Checks whether Log Service is activated. |
| DescribeWebAccessLogEmptyCount | DescribeWebAccessLogEmptyCount | Queries the remaining quota that allows you to clear the Logstore. |
| DescribeDefenseRecords | DescribeDefenseRecords | Queries the advanced mitigation logs of Anti-DDoS Premium. |
| EmptySlsLogstore | EmptySlsLogstore | Clears the Logstore of Anti-DDoS Pro or Anti-DDoS Premium. |
System configuration and logs
| API | Title | Description |
|---|---|---|
| DescribeStsGrantStatus | DescribeStsGrantStatus | Queries whether Anti-DDoS Pro or Anti-DDoS Premium is authorized to access other cloud services. |
| DescribeAsyncTasks | DescribeAsyncTasks | Queries the details of asynchronous export tasks, such as the IDs, start time, end time, status, parameters, and results. |
| DescribeSystemLog | DescribeSystemLog | Queries the details of the bills for the burstable clean bandwidth. |
Tag
| API | Title | Description |
|---|---|---|
| CreateTagResources | CreateTagResources | Adds tags to multiple Anti-DDoS Proxy (Chinese Mainland) instances at a time. |
| DeleteTagResources | DeleteTagResources | Removes tags from Anti-DDoS Proxy (Chinese Mainland) instances. |
| 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. |
Port
| API | Title | Description |
|---|---|---|
| CreatePort | CreatePort | Creates a port forwarding rule. |
| DeletePort | DeletePort | Deletes the specified port forwarding rule. |
| ModifyPort | ModifyPort | Modifies a port forwarding rule. |
| DescribePort | DescribePort | Queries the port forwarding rules that are created for an Anti-DDoS Pro or Anti-DDoS Premium instance. |
Other
| API | Title | Description |
|---|---|---|
| CreateDomainResource | CreateDomainResource | Creates a forwarding rule for a website. |
| DeleteDomainResource | DeleteDomainResource | Deletes a specified forwarding rule of a website. |
| DescribeDomainResource | DescribeDomainResource | Queries the configurations of a forwarding rule. |
| ModifyDomainResource | ModifyDomainResource | Modifies 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. |
| DescribeLayer4RulePolicy | DescribeLayer4RulePolicy | Queries the back-to-origin settings of a port forwarding rule. |
| DescribeInstanceExt | DescribeInstanceExt | Queries the information about Anti-DDoS Pro and Anti-DDoS Premium instances. |