API standards and multilingual preset SDKs
The OpenAPI of this product (antiddos-public/2017-05-18) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Region information
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries the regions in which Anti-DDoS Origin Basic is available. |
Asset
|
API |
Title |
Description |
| DescribeDdosCredit | DescribeDdosCredit | Retrieves the details of the security credit score of the current Alibaba Cloud account in a specific region. |
| DescribeInstance | DescribeInstance | Retrieves the details of the assets within the current Alibaba Cloud account. 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. This operation is phased out. We recommend that you use the DescribeInstanceIpAddress operation. |
| DescribeDdosThreshold | DescribeDdosThreshold | Retrieves the details of the DDoS mitigation thresholds or traffic scrubbing thresholds for specified assets. 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. |
| DescribeBgpPackByIp | DescribeBgpPackByIp | Queries the configurations of the Anti-DDoS Origin instance that is associated with an asset. The asset is assigned a public IP address. |
| DescribeInstanceIpAddress | DescribeInstanceIpAddress | Retrieves the details of the assets within the current Alibaba Cloud account and the details of the Anti-DDoS Origin instance to which the assets belong. 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. |
| DescribeIpDdosThreshold | DescribeIpDdosThreshold | Retrieves the details of the DDoS mitigation thresholds or traffic scrubbing thresholds for specified assets. 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. |
| DescribeIpLocationService | DescribeIpLocationService | Queries the region to which the public IP address of the asset within the current Alibaba Cloud account belongs. The asset can be an elastic IP address (EIP). The asset can also be an Elastic Compute Service (ECS) instance or Server Load Balancer (SLB) instance that is assigned a public IP address. |
Protection
|
API |
Title |
Description |
| ModifyIpDefenseThreshold | ModifyIpDefenseThreshold | Modifies the scrubbing thresholds for an asset that is assigned a public IP address. This operation is a synchronous operation that supports Terraform. |
| ModifyDefenseThreshold | ModifyDefenseThreshold | Modifies the Anti-DDoS scrubbing threshold for a single asset with a public IP address. |
| DescribeDdosEventList | DescribeDdosEventList | Lists DDoS attack events for a specified asset with a public IP address. |
| DescribeDdosCount | DescribeDdosCount | Queries the number of assets that are under DDoS attacks in a specific region. The assets are assigned public IP addresses. |
| DescribeCap | DescribeCap | Queries the download link to the traffic data that is captured when a DDoS attack event occurs. |