API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (ddosbgp/2018-07-20) 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. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Policy
|
API |
Title |
Description |
| CreatePolicy | CreatePolicy | Creates a mitigation policy. |
| DeletePolicy | DeletePolicy | Deletes a mitigation policy. |
| ModifyPolicy | ModifyPolicy | Modifies a mitigation policy. |
| ModifyPolicyContent | ModifyPolicyContent | Modifies the content of the mitigation policy. |
| ListPolicy | ListPolicy | Queries mitigation policies. |
| AttachToPolicy | AttachToPolicy | Associates a mitigation policy to a protected object. |
| DetachFromPolicy | DetachFromPolicy | Removes protected objects from a mitigation policy. |
| ListPolicyAttachment | ListPolicyAttachment | Queries attachments to mitigation policies. |
Multi-account management
|
API |
Title |
Description |
| DescribeRdStatus | DescribeRdStatus | Queries the status of the multi-account management feature. |
| DescribeRdMemberList | DescribeRdMemberList | Queries members in a resource directory. |
| AddRdMemberList | AddRdMemberList | Adds members to a resource directory. |
| DeleteRdMemberList | DeleteRdMemberList | Deletes members. |
Instances
|
API |
Title |
Description |
| ModifyRemark | ModifyRemark | Adds remarks for a single Anti-DDoS Origin instance. |
| DescribeRegions | DescribeRegions | Queries the regions of assets that can be protected by Anti-DDoS Origin Enterprise in a specific region. |
| DescribeInstanceList | DescribeInstanceList | Queries the details of all Anti-DDoS Origin instances. |
| DescribeInstanceSpecs | DescribeInstanceSpecs | Queries the specifications of a specific Anti-DDoS Origin instance. |
| DescribeExcpetionCount | DescribeExcpetionCount | Queries the number of assets that are in an abnormal state and the number of Anti-DDoS Origin instances that are about to expire. 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. |
| DescribePackIpList | DescribePackIpList | Queries the list of protected IP addresses for a single Anti-DDoS Origin instance. |
| GetSlsOpenStatus | GetSlsOpenStatus | Queries whether Simple Log Service is activated. |
| CheckGrant | CheckGrant | Queries whether Anti-DDoS Origin is authorized to obtain information about the assets within the current Alibaba Cloud account. |
Protection
|
API |
Title |
Description |
| DettachAssetGroupToInstance | DettachAssetGroupToInstance | Dissociates an asset from an Anti-DDoS Origin instance of a paid edition. |
| DescribeAssetGroupToInstance | DescribeAssetGroupToInstance | Queries the association between an asset and an Anti-DDoS Origin instance of a paid edition. |
| AttachAssetGroupToInstance | AttachAssetGroupToInstance | Associates an asset with an Anti-DDoS Origin instance of a paid edition. |
| DescribeAssetGroup | DescribeAssetGroup | Queries the association between an asset and an Anti-DDoS Origin instance of a paid edition. |
| AddIp | AddIp | Adds IP addresses to an Anti-DDoS Origin instance. |
| DeleteIp | DeleteIp | Deletes an IP address from Anti-DDoS Origin and disables protection for that IP address. |
| DeleteBlackhole | DeleteBlackhole | Deactivates blackhole filtering for a protected IP address. |
Logs
|
API |
Title |
Description |
| DescribeDdosEvent | DescribeDdosEvent | Queries the details about the DDoS attack events that occurred on an Anti-DDoS Origin instance. |
| DescribeOpEntities | DescribeOpEntities | Queries the operation logs of an Anti-DDoS Origin instance. |
| DescribeTraffic | DescribeTraffic | Queries traffic statistics of an Anti-DDoS Origin instance within a specific time period. |
| ListOpenedAccessLogInstances | ListOpenedAccessLogInstances | Queries the Anti-DDoS Origin instances for which log analysis is enabled. |
| CheckAccessLogAuth | CheckAccessLogAuth | Queries whether Anti-DDoS Origin is authorized to access Simple Log Service. |
Tags
|
API |
Title |
Description |
| ListTagKeys | ListTagKeys | Queries all tags. |
| ListTagResources | ListTagResources | Queries the relationship between Anti-DDoS Origin instances and tags. |
| TagResources | TagResources | Add tags to Anti-DDoS Origin instances. |
| UntagResources | UntagResources | Removes tags from Anti-DDoS Origin instances. |
Other
|
API |
Title |
Description |
| ReleaseDdosOriginInstance | ReleaseDdosOriginInstance | Releases a pay-as-you-go Anti-DDoS Origin instance. |
| DescribeDdosOriginInstanceBill | DescribeDdosOriginInstanceBill | Queries the bill of an Anti-DDoS Origin (Pay-as-you-go) instance. |
| MoveResourceGroup | MoveResourceGroup | Changes the resource group to which a cloud resource belongs. |