API overview

API standards and multilingual preset SDKs

The OpenAPI of this product (ddosbgp/2018-07-20) 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.

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.

Instance

API	Title	Description
DescribeInstanceList	DescribeInstanceList	Retrieves the details of all Anti-DDoS Origin instances.
DescribePackIpList	DescribePackIpList	Queries the list of protected IP addresses for a single Anti-DDoS Origin instance.
CheckGrant	CheckGrant	Queries whether Anti-DDoS Origin is authorized to obtain information about the assets within the current Alibaba Cloud account.

Log

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.

Tag

API	Title	Description
AddIp	AddIp	Adds IP addresses to an Anti-DDoS Origin instance.
AttachAssetGroupToInstance	AttachAssetGroupToInstance	Associates an asset with an Anti-DDoS Origin instance of a paid edition.
AttachToPolicy	AttachToPolicy	Attaches a protected object to a mitigation policy.
CheckAccessLogAuth	CheckAccessLogAuth	Queries whether Anti-DDoS Origin is authorized to access Simple Log Service.
CreatePolicy	CreatePolicy	Creates a mitigation policy.
DeleteBlackhole	DeleteBlackhole	Deactivates blackhole filtering for a protected IP address.
DeleteIp	DeleteIp	Deletes an IP address from Anti-DDoS Origin and disables protection for that IP address.
DeletePolicy	DeletePolicy	Deletes a mitigation policy.
DescribeAssetGroup	DescribeAssetGroup	Queries the association between an asset and 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.
DescribeDdosEvent	DescribeDdosEvent	Queries the details about the DDoS attack events that occurred on an 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.
DescribeInstanceSpecs	DescribeInstanceSpecs	Queries the specifications of a specific Anti-DDoS Origin instance.
DescribeNetworkLayerIntercepts	DescribeNetworkLayerIntercepts	Anti-DDoS Origin: Query network layer blocking logs
DescribeOpEntities	DescribeOpEntities	Queries the operation logs of an Anti-DDoS Origin instance.
DescribeRegions	DescribeRegions	Queries the regions of assets that can be protected by Anti-DDoS Origin Enterprise in a specific region.
DescribeTraffic	DescribeTraffic	Queries traffic statistics of an Anti-DDoS Origin instance within a specific time period.
DetachFromPolicy	DetachFromPolicy	Detaches a protected object from a mitigation policy.
DettachAssetGroupToInstance	DettachAssetGroupToInstance	Dissociates an asset from an Anti-DDoS Origin instance of a paid edition.
GetSlsOpenStatus	GetSlsOpenStatus	Queries whether Simple Log Service is activated.
ListOpenedAccessLogInstances	ListOpenedAccessLogInstances	Queries the Anti-DDoS Origin instances for which log analysis is enabled.
ListPolicy	ListPolicy	Lists mitigation policies.
ListPolicyAttachment	ListPolicyAttachment	Lists the associations of mitigation policies.
ListTagKeys	ListTagKeys	Queries all tags.
ListTagResources	ListTagResources	Queries the relationship between Anti-DDoS Origin instances and tags.
ModifyPolicy	ModifyPolicy	Modifies an existing mitigation policy.
ModifyPolicyContent	ModifyPolicyContent	Modifies the content of a mitigation policy.
ModifyRemark	ModifyRemark	Adds remarks for a single Anti-DDoS Origin instance.
MoveResourceGroup	MoveResourceGroup	Changes the resource group to which a cloud resource belongs.
TagResources	TagResources	Add tags to Anti-DDoS Origin instances.
UntagResources	UntagResources	Removes tags from Anti-DDoS Origin instances.