The following tables list API operations available for use in Anti-DDoS Origin Enterprise. The version number of the API operations are 2018-07-20. For more information, see related documentation.

Notice Before you call the following operations, make sure that you have purchased an Anti-DDoS Origin Enterprise instance. For more information, see Purchase an Anti-DDoS Origin Enterprise instance.

Protection setting management

Operation Description
AddIp Adds assets to an Anti-DDoS Origin Enterprise instance. The assets can be elastic IP addresses (EIPs). The assets can also be Elastic Compute Service (ECS) instances or Server Load Balancer (SLB) instances that are assigned public IP addresses.
DeleteIp Removes protected public IP addresses from an Anti-DDoS Origin Enterprise instance.
DeleteBlackhole Deactivates blackhole filtering for a protected public IP address.

Instance management

Operation Description
DescribeRegions Queries regions in which Anti-DDoS Origin Enterprise is available.
DescribeInstanceList Queries the details of Anti-DDoS Origin Enterprise instances. The details include the ID, validity period, and status of each instance.
DescribeInstanceSpecs Queries the specifications of an Anti-DDoS Origin Enterprise instance. The specifications include whether the best effort protection feature is enabled, and the numbers of times that best effort protection can be provided and has been provided.
DescribeExcpetionCount Queries the number of public IP addresses that are in the abnormal state and the number of Anti-DDoS Origin Enterprise instances that are about to expire. If blackhole filtering is triggered for a public IP address, the IP address is in the abnormal state. An instance whose remaining validity period is less than 7 days is considered as an instance that is about to expire.
DescribePackIpList Queries the IP addresses that are protected by an Anti-DDoS Origin Enterprise instance.
ModifyRemark Modifies the remarks about an Anti-DDoS Origin Enterprise instance.
CheckGrant Queries whether Anti-DDoS Origin Enterprise is authorized to obtain information about the assets within the current Alibaba Cloud account.

Log management

Operation Description
DescribeDdosEvent Queries the details about the DDoS attack events that occurred on an Anti-DDoS Origin Enterprise instance. The details include the start time, end time, attacked IP address, and status of each event.
DescribeOpEntities Queries the operation logs of an Anti-DDoS Origin Enterprise instance. The operation logs include information about adding an IP address to the Anti-DDoS Origin Enterprise instance for protection, removing a protected IP address from the Anti-DDoS Origin Enterprise instance, and deactivating blackhole filtering for an IP address.
DescribeTraffic Queries traffic statistics of an Anti-DDoS Origin Enterprise instance.

Tag management

Operation Description
ListTagKeys Queries all tags.
TagResources Adds tags to Anti-DDoS Origin Enterprise instances.
UntagResources Removes tags from Anti-DDoS Origin Enterprise instances.
ListTagResources Queries the tags that are added to Anti-DDoS Origin Enterprise instances.

On-demand instance management

Operation Description
DescribeOnDemandDdosEvent Queries the details about the DDoS attack events that occurred on an on-demand instance. The details include the start time, end time, volume of attack traffic, and status of each event.
DescribeOnDemandInstanceStatus Queries the information about on-demand instances. The information includes the ID, scheduling mode, and CIDR block of each on-demand instance.
SetInstanceModeOnDemand Specifies the scheduling mode for on-demand instances.
CreateSchedruleOnDemand Creates a scheduling rule for an on-demand instance.
QuerySchedruleOnDemand Queries scheduling rules of an on-demand instance.
ConfigSchedruleOnDemand Modifies a scheduling rule of an on-demand instance.
DeleteSchedruleOnDemand Deletes a scheduling rule of an on-demand instance.
You can also call the following API operations whose version number is 2017-11-20 to manage on-demand instances in Anti-DDoS Origin Enterprise:
Notice If you call the API operations whose version number is 2017-11-20, you must set the common request parameter version to 2017-11-20. For more information, see Make API requests.
  • DescribeOnDemandInstance: queries the details of on-demand instances. The details include whether an on-demand instance is enabled and the CIDR block of each on-demand instance.
  • ModifyOnDemaondDefenseStatus: modifies the protection status of an on-demand instance.
  • DescribeTopTraffic: queries the top N IP addresses from which the most traffic is forwarded by an on-demand instance within a specific period.

Protection analysis management

Operation Description
GetSlsOpenStatus Queries whether Log Service is activated.
CheckAccessLogAuth Queries whether Anti-DDoS Origin Enterprise is authorized to access Log Service.
ListOpenedAccessLogInstances Queries the Anti-DDoS Origin Enterprise instances for which log analysis is enabled.