# Alibaba Cloud DDoS API

> Alibaba Cloud DDoS API on Apizie: 14 endpoints (Queries the configurations of the Anti-DDoS Origin instance that is associated with an asset. The asset is…, Queries the download link to the traffic data that is captured when a DDoS attack event occurs, Queries the number of assets that are under DDoS attacks in a specific region. The assets are assigned…, Retrieves the details of the security credit score of the current Alibaba Cloud account in a specific region, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-antiddos-public/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-antiddos-public`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/antiddos-public
- Page: https://apizie.tech/api/cloud/aliyun-antiddos-public
- OpenAPI: https://apizie.tech/api/cloud/aliyun-antiddos-public/openapi.json

Alibaba Cloud OpenAPI for DDoS (antiddos-public, version 2017-05-18). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Queries the configurations of the Anti-DDoS Origin instance that is associated with an asset. The asset is…
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-bgp-pack-by-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset to query. You can call the https://help.aliyun.com/document_detail/353250.html operation to query the most… |
| Ip | string | yes | The IP address of the asset to query. You can call the https://help.aliyun.com/document_detail/472620.html operation to query the IDs of… |

### Queries the download link to the traffic data that is captured when a DDoS attack event occurs
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-cap` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset that is under DDoS attacks. The asset is assigned a public IP address. You can call the… |
| InstanceType | string | yes | The type of the asset that is under DDoS attacks. The asset is assigned a public IP address. Valid values: ecs: an Elastic Compute Service… |
| InstanceId | string | yes | The ID of the asset that is under DDoS attacks. You can call the https://help.aliyun.com/document_detail/354191.html operation to query… |
| BegTime | integer | yes | The start time of the DDoS attack event. The value is a UNIX timestamp. Unit: milliseconds. You can call the… |
| InternetIp | string | no | The public IP address of the asset that is under DDoS attacks |

### Queries the number of assets that are under DDoS attacks in a specific region. The assets are assigned…
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-ddos-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset to query. You can call the https://help.aliyun.com/document_detail/353250.html operation to query the most… |
| InstanceType | string | yes | The type of the asset to query. Valid values: ecs: Elastic Compute Service (ECS) instances. slb: Server Load Balancer (SLB) instances.… |

### Retrieves the details of the security credit score of the current Alibaba Cloud account in a specific region
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-ddos-credit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The ID of the region. You can call the https://help.aliyun.com/document_detail/353250.html operation to query the most recent region list |

### Lists DDoS attack events for a specified asset with a public IP address
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-ddos-event-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset that is assigned a public IP address. Call https://help.aliyun.com/document_detail/353250.html to query all… |
| InstanceType | string | yes | The instance type of the asset that is assigned a public IP address. Valid values: ecs: an Elastic Compute Service (ECS) instance. slb: a… |
| InstanceId | string | yes | The ID of the instance for the asset that is assigned a public IP address. Call https://help.aliyun.com/document_detail/354191.html to… |
| CurrentPage | integer | no | The number of the page to return for a paged query. Default value: 1 |
| PageSize | integer | no | The number of attack events to return on each page for a paged query. Default value: 10 |
| InternetIp | string | no | The IP address of the asset that is assigned a public IP address |
| QueryDays | integer | no | The number of days to query backwards from the current time. Default value: 7 |

### Retrieves the details of the DDoS mitigation thresholds or traffic scrubbing thresholds for specified…
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-ddos-threshold` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset. You can call the https://help.aliyun.com/document_detail/353250.html operation to query the most recent region… |
| DdosType | string | yes | The type of the threshold. Valid values: defense: traffic scrubbing threshold blackhole: DDoS mitigation threshold |
| InstanceType | string | yes | The type of the asset that is assigned a public IP address. Valid values: ecs: ECS instances. slb: SLB instances. eip: EIPs. ipv6: IPv6… |
| InstanceIds | string | yes | The ID of asset N to query (JSON-encoded) |

### Retrieves the details of the assets within the current Alibaba Cloud account. The assets can be elastic IP…
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset. You can call the https://help.aliyun.com/document_detail/353250.html operation to query the most recent region… |
| InstanceType | string | yes | The type of the asset to query. Valid values: ecs: ECS instances. slb: SLB instances. eip: EIPs. ipv6: IPv6 gateways. swas: simple… |
| InstanceName | string | no | The name of the asset |
| DdosStatus | string | no | The DDoS mitigation status of the asset. Valid values: mitigating: queries assets for which traffic scrubbing is triggered. blackholed:… |
| InstanceId | string | no | The ID of the asset. The formats of asset IDs vary based on the value of the InstanceType. parameter. If you set InstanceType to ecs,… |
| InstanceIp | string | no | The IP address of the asset |
| CurrentPage | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |

### Retrieves the details of the assets within the current Alibaba Cloud account and the details of the…
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-instance-ip-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset. You can call the https://help.aliyun.com/document_detail/353250.html operation to query the most recent region… |
| InstanceType | string | yes | The type of the asset that is assigned a public IP address. Valid values: ecs: ECS instances. slb: SLB instances. eip: EIPs. ipv6: IPv6… |
| InstanceName | string | no | The name of the asset |
| DdosStatus | string | no | The DDoS mitigation status of the asset. Valid values: defense: queries assets for which traffic scrubbing is performed. blackhole:… |
| InstanceId | string | no | The ID of the instance to which the asset is added |
| InstanceIp | string | no | The IP address of the asset |
| CurrentPage | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |

### Retrieves the details of the DDoS mitigation thresholds or traffic scrubbing thresholds for specified…
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-ip-ddos-threshold` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset. You can call the https://help.aliyun.com/document_detail/353250.html operation to query the most recent region… |
| DdosType | string | yes | The type of the threshold. Valid values: defense: traffic scrubbing threshold blackhole: DDoS mitigation threshold |
| InstanceType | string | yes | The type of the asset that is assigned a public IP address. Valid values: ecs: ECS instances. slb: SLB instances. eip: EIPs. ipv6: IPv6… |
| InstanceId | string | yes | The ID of the asset. You can call the https://help.aliyun.com/document_detail/429562.html operation to query the IDs of ECS instances, SLB… |
| InternetIp | string | yes | The IP address of the asset |

### Queries the region to which the public IP address of the asset within the current Alibaba Cloud account…
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-ip-location-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| InternetIp | string | yes | The IP address of the asset to query |

### Queries the regions in which Anti-DDoS Origin Basic is available
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |

### Modifies the Anti-DDoS scrubbing threshold for a single asset with a public IP address
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/modify-defense-threshold` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset that is assigned a public IP address. Call https://help.aliyun.com/document_detail/353250.html to query all… |
| InstanceType | string | yes | The instance type of the asset that is assigned a public IP address. Valid values: ecs: Elastic Compute Service (ECS) instance. slb:… |
| InstanceId | string | yes | The instance ID of the asset that is assigned a public IP address. Call https://help.aliyun.com/document_detail/354191.html to query the… |
| Bps | integer | no | The scrubbing threshold for traffic in Mbps. This value cannot exceed the peak public network traffic of the instance. If you specify Bps,… |
| Pps | integer | no | The scrubbing threshold for packets per second (pps). This value cannot exceed the peak packet traffic of the instance. If you specify… |
| IsAuto | string | no | Specifies whether to automatically adjust the scrubbing threshold based on the traffic loads of the instance. Valid values: true: The… |
| InternetIp | string | no | The public IP address of the asset |
| ClientToken | string | no | The ClientToken |

### Modifies the scrubbing thresholds for an asset that is assigned a public IP address. This operation is a…
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/modify-ip-defense-threshold` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |
| DdosRegionId | string | yes | The region ID of the asset. You can call the https://help.aliyun.com/document_detail/353250.html operation to query the most recent region… |
| InstanceType | string | yes | The type of the asset. Valid values: ecs: an Elastic Compute Service (ECS) instance. slb: a Server Load Balancer (SLB) instance. eip: an… |
| InstanceId | string | yes | The ID of the asset. You can call the https://help.aliyun.com/document_detail/354191.html operation to query the IDs of ECS instances, SLB… |
| Bps | integer | no | The traffic scrubbing threshold. Unit: Mbit/s. The traffic scrubbing threshold cannot exceed the peak inbound or outbound Internet… |
| Pps | integer | no | The packet scrubbing threshold. Unit: packets per second (PPS). When you modify Pps, Bps is required. Otherwise, Pps does not take effect.… |
| IsAuto | string | no | Specifies whether to automatically adjust the scrubbing threshold based on the traffic load on the asset. Valid values: true:… |
| InternetIp | string | yes | The IP address of the asset |

### version
`POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://antiddos.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-bgp-pack-by-ip" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud DDoS API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-antiddos-public/describe-bgp-pack-by-ip with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud DDoS API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud DDoS itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud DDoS API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-antiddos-public.

### What is the status of the Alibaba Cloud DDoS API?
Needs your own provider key (bring your own key)