# Alibaba Cloud Protection Package API

> Alibaba Cloud Protection Package API on Apizie: 41 endpoints (Adds IP addresses to an Anti-DDoS Origin instance, Adds members to a resource directory, Associates an asset with an Anti-DDoS Origin instance of a paid edition, Associates protection objects with a mitigation policy, …) 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://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-ddosbgp`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/ddosbgp
- Page: https://zieapi.vercel.app/api/cloud/aliyun-ddosbgp
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-ddosbgp/openapi.json

Alibaba Cloud OpenAPI for Protection Package (ddosbgp, version 2018-07-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds IP addresses to an Anti-DDoS Origin instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/add-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| IpList | string | yes | The list of IP addresses to add to the Anti-DDoS Origin instance for protection. The value is a string that is converted from a JSON… |
| InstanceId | string | yes | The ID of the Anti-DDoS Origin instance to manage. Call https://help.aliyun.com/document_detail/118698.html to query the IDs of all… |
| RegionId | string | no | The region ID of the Anti-DDoS Origin instance. Call https://help.aliyun.com/document_detail/118703.html to query information about all… |
| ResourceGroupId | string | no | The ID of the resource group in Resource Management to which the Anti-DDoS Origin instance belongs. If you leave this parameter empty, the… |

### Adds members to a resource directory
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/add-rd-member-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| MemberList | string | yes | The list of the members (JSON-encoded) |

### Associates an asset with an Anti-DDoS Origin instance of a paid edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/attach-asset-group-to-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region in which the instance resides. You can call the https://help.aliyun.com/document_detail/118703.html operation to… |
| InstanceId | string | yes | The ID of the instance to query. You can call the https://help.aliyun.com/document_detail/118698.html operation to query the IDs of all… |
| AssetGroupList | string | yes | The information about the asset to be associated (JSON-encoded) |

### Associates protection objects with a mitigation policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/attach-to-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| PolicyId | string | yes | The policy ID |
| IpPortProtocolList | string | yes | The list of protection objects (JSON-encoded) |
| PortVersion | string | no | The version of the port-specific mitigation policy. Valid values: Not specified: Binds the default surf protection engine policy. 2: Binds… |

### Queries whether Anti-DDoS Origin is authorized to access Simple Log Service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/check-access-log-auth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the Anti-DDoS Origin instance. For more information about the valid values of this parameter, see… |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If this parameter is empty, the… |

### Queries whether Anti-DDoS Origin is authorized to obtain information about the assets within the current…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/check-grant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter,… |
| RegionId | string | no | The ID of the region where the Anti-DDoS Origin instance resides. You can call the https://help.aliyun.com/document_detail/118703.html… |
| IsSlr | string | no | Specifies whether to allow Anti-DDoS Origin to check the service-linked role. Valid values: true false |

### Creates a mitigation policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/create-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The policy name |
| Type | string | yes | The policy type. Valid values: l3: IP-specific mitigation policy. l4: port-specific mitigation policy |
| PortVersion | string | no | The version of the port-specific mitigation policy. Valid values: Not specified: creates a default surf DPI engine policy. 2: creates a… |

### Deactivates blackhole filtering for a protected IP address
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/delete-blackhole` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| Ip | string | yes | The IP address for which you want to deactivate blackhole filtering. You can call the https://help.aliyun.com/document_detail/118701.html… |
| InstanceId | string | yes | The ID of the Anti-DDoS Origin instance. You can call the https://help.aliyun.com/document_detail/118698.html operation to query the IDs… |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter,… |
| RegionId | string | no | The ID of the region where the Anti-DDoS Origin instance resides. You can call the https://help.aliyun.com/document_detail/118703.html… |

### Deletes an IP address from Anti-DDoS Origin and disables protection for that IP address
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/delete-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| IpList | string | yes | A list of IP addresses to remove from the protected objects of the Anti-DDoS Origin instance. Specify the list as a string that is a JSON… |
| InstanceId | string | yes | The ID of the Anti-DDoS Origin instance. Call https://help.aliyun.com/document_detail/118698.html to query the IDs of all Anti-DDoS Origin… |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you leave this parameter empty, the… |
| RegionId | string | no | The region ID of the Anti-DDoS Origin instance. Call https://help.aliyun.com/document_detail/118703.html to query all regions that… |

### Deletes a mitigation policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/delete-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the policy |

### Deletes members
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/delete-rd-member-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| MemberList | string | yes | The list of the members (JSON-encoded) |

### Queries the association between an asset and an Anti-DDoS Origin instance of a paid edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-asset-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region in which the instance resides. You can call the https://help.aliyun.com/document_detail/118703.html operation to… |
| Name | string | no | The ID of the asset. If the asset is a Web Application Firewall (WAF) instance, specify the ID of the WAF instance |
| Type | string | yes | The type of the asset. Valid values: waf: WAF instance ga: Global Accelerator (GA) instance |
| Region | string | yes | The region ID of the asset |

### Queries the association between an asset and an Anti-DDoS Origin instance of a paid edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-asset-group-to-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region in which the instance resides. You can call the https://help.aliyun.com/document_detail/118703.html operation to… |
| InstanceId | string | no | The ID of the instance to query. You can call the https://help.aliyun.com/document_detail/118698.html operation to query the IDs of all… |
| Name | string | no | The ID of the asset. If the asset is a Web Application Firewall (WAF) instance, specify the ID of the WAF instance |
| Type | string | no | The type of the asset. Valid values: waf: WAF instance ga: Global Accelerator (GA) instance |
| Region | string | no | The region ID of the asset |
| MemberUid | string | no | The UID of the member to which the asset belongs |

### Queries the details about the DDoS attack events that occurred on an Anti-DDoS Origin instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-ddos-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| StartTime | integer | yes | The start time of the DDoS attack events to query. This value is a UNIX timestamp. Unit: seconds |
| EndTime | integer | yes | The end time of the DDoS attack events to query. This value is a UNIX timestamp. Unit: seconds |
| PageSize | integer | yes | The number of entries per page |
| PageNo | integer | yes | The page number |
| InstanceId | string | yes | The ID of the Anti-DDoS Origin instance to query. You can call the https://help.aliyun.com/document_detail/118698.html operation to query… |
| Ip | string | no | The attacked IP address to query |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter,… |
| RegionId | string | no | The ID of the region where the Anti-DDoS Origin instance resides. You can call the https://help.aliyun.com/document_detail/118703.html… |

### Queries the pay-as-you-go billing information of an Anti-DDoS Origin instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-ddos-origin-instance-bill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| Type | string | no | The bill type. Valid values: flow_cn: clean traffic bill for EIPs with Anti-DDoS (Enhanced) enabled in the Chinese mainland. flow_ov:… |
| StartTime | integer | no | The start timestamp of the query. Unit: milliseconds |
| EndTime | integer | no | The end timestamp of the query. Unit: milliseconds. The time span cannot exceed 30 days |
| IsShowList | string | no | Specifies whether to display billing details. Valid values: true: Displays billing information. false: Displays only global instance… |

### Queries the number of assets that are in an abnormal state and the number of Anti-DDoS Origin instances that…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-excpetion-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter,… |
| RegionId | string | no | The ID of the region where the Anti-DDoS Origin instance resides. You can call the https://help.aliyun.com/document_detail/118703.html… |

### Queries the details of Anti-DDoS Origin instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-instance-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter,… |
| InstanceIdList | string | no | The IDs of the Anti-DDoS Origin instances to query. Specify the value in the `[" "," ",……]` format |
| Remark | string | no | The remark of the Anti-DDoS Origin instance to query. Fuzzy match is supported |
| PageNo | integer | yes | The page number of the current page in a paging query. Settings the current page number |
| PageSize | integer | yes | The number of instances on each page in a paging query. Settings the number of instances per page |
| IpVersion | string | no | The protocol type of the IP assets protected by the Anti-DDoS Origin instance to query. Valid values: IPv4: IPv4 protocol. IPv6: IPv6… |
| InstanceType | string | no | The mitigation plan type of the Anti-DDoS Origin instance to query. Valid values: 0: Professional. 1: Enterprise |
| Ip | string | no | The protected IP address of the Anti-DDoS Origin instance to query |
| Orderby | string | no | The sort field for the Anti-DDoS Origin instance list. The value is fixed as expireTime, which indicates sorting by instance expiration… |
| Orderdire | string | no | The sort order. Valid values: desc (default): descending order by expiration time. asc: ascending order by expiration time |
| RegionId | string | no | The region ID of the Anti-DDoS Origin instance to query. You can call https://help.aliyun.com/document_detail/118703.html to query all… |
| Tag | string | no | The tags bound to the Anti-DDoS Origin instances to query (JSON-encoded) |
| InstanceTypeList | string | no | The mitigation plan types of the Anti-DDoS Origin instances to query (JSON-encoded) |

### Queries the specifications of a specific Anti-DDoS Origin instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-instance-specs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| InstanceIdList | string | yes | The ID of the Anti-DDoS Origin instance. This parameter is a string that consists of JSON arrays. Each element in a JSON array indicates… |
| RegionId | string | no | The region ID of the Anti-DDoS Origin instance. Default value: cn-hangzhou, which indicates the China (Hangzhou) region. If your instance… |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. This parameter is empty by default,… |

### Queries the network-layer interception records of Anti-DDoS Origin instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-network-layer-intercepts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the Anti-DDoS Origin instance to query |
| SrcIp | string | no | The source IP address |
| DestinationIp | string | no | The destination IP address |
| NetworkProtocol | string | no | The network protocol |
| SourcePort | integer | no | The source port |
| DestinationPort | integer | no | The destination port |
| StartTime | integer | yes | The start time of the DDoS attack event to query. The value is a UNIX timestamp. Unit: seconds |
| EndTime | integer | yes | The end time of the DDoS attack event to query. The value is a UNIX timestamp. Unit: seconds |
| Page | integer | no | The page number |
| PageSize | integer | no | The number of interception log entries per page in a paged query |
| ProtocolNumber | integer | no | The network protocol number. This is a standard network protocol number |
| InterceptModule | string | no | The interception module |

### Queries the operation logs of an Anti-DDoS Origin instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-op-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| CurrentPage | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page. Maximum value: 50 |
| StartTime | integer | yes | The start time. Operation logs that were generated after this time are queried.**** The value is a UNIX timestamp. Unit: milliseconds |
| EndTime | integer | yes | The end time. Operation logs that were generated before this time are queried.**** The value is a UNIX timestamp. Unit: milliseconds |
| OrderBy | string | no | The sorting method of operation logs. Set the value to opdate, which indicates sorting based on the operation time |
| OrderDir | string | no | The sort order of operation logs. Valid values: ASC: the ascending order. DESC: the descending order. Default value: DESC |
| InstanceId | string | no | The ID of the instance to query. You can call the https://help.aliyun.com/document_detail/118698.html operation to query the IDs of all… |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. If you do not specify this parameter, the instance… |
| RegionId | string | no | The ID of the region where the instance resides. You can call the https://help.aliyun.com/document_detail/118703.html operation to query… |
| OpAction | integer | no | The type of the operation. Valid values: 3: Add an IP address to the instance. 4: Remove an IP address from the instance. 5: Downgrade the… |

### Queries the list of protected IP addresses for a single Anti-DDoS Origin instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-pack-ip-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| PageNo | integer | yes | The number of the page to return |
| PageSize | integer | yes | The number of protected IP addresses to return on each page. The maximum value is 50 |
| InstanceId | string | yes | The ID of the Anti-DDoS Origin instance to query. Call https://help.aliyun.com/document_detail/118698.html to query the IDs of all… |
| Ip | string | no | The protected IP address to query |
| ProductName | string | no | The type of the cloud asset to which the protected IP address belongs. Valid values: ECS: an Elastic Compute Service (ECS) instance. SLB:… |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not set this parameter, the… |
| RegionId | string | no | The region ID of the Anti-DDoS Origin instance. Call https://help.aliyun.com/document_detail/118703.html to query the IDs of all regions… |
| MemberUid | string | no | The UID of the member account |

### Queries members in a resource directory
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-rd-member-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| PageNo | integer | no | The page number |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| ResourceDirectoryId | string | no | The ID of the resource directory |

### Queries the status of the multi-account management feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-rd-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |

### Queries all regions supported by Anti-DDoS Origin Enterprise
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. By default, this parameter is empty,… |
| RegionId | string | no | The region ID to query. Default value: ap-southeast-1, which indicates that the regions of cloud assets that can be protected by the… |

### Queries the traffic statistics of a specified Anti-DDoS Origin instance within a specified time period
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/describe-traffic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the Anti-DDoS Origin instance to query. You can call https://help.aliyun.com/document_detail/118698.html to query the IDs of all… |
| Ipnet | string | no | The CIDR block used for traffic diversion to query |
| Ip | string | no | The assets that are assigned public IP addresses to query. If you do not specify this parameter in Settings, the traffic statistics of all… |
| StartTime | integer | yes | The start time of the query. Specify a UNIX timestamp. Unit: seconds |
| EndTime | integer | no | The end time of the query. Specify a UNIX timestamp. Unit: seconds. If you do not set this parameter, the current time is used as the end… |
| Interval | integer | no | The time interval for traffic statistics. Unit: seconds. This parameter specifies the length of each interval for which traffic data is… |
| FlowType | string | no | The type of traffic statistics to query. Valid values: max: the peak traffic within the statistical interval. avg: the average traffic… |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not set this parameter, the… |
| RegionId | string | no | The region ID of the Anti-DDoS Origin instance. You can call https://help.aliyun.com/document_detail/118703.html to query all region IDs… |

### Dissociates a mitigation policy from a protected object
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/detach-from-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| PolicyType | string | yes | The policy type. Valid values: default: default mitigation policy. l3: IP-specific mitigation policy. l4: port-specific mitigation policy |
| IpPortProtocolList | string | yes | The list of protected objects (JSON-encoded) |
| PortVersion | string | no | The version of the port-specific mitigation policy. Valid values: Not specified: dissociates the default surf anti-DDoS engine policy. 2:… |

### Dissociates an asset from an Anti-DDoS Origin instance of a paid edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/dettach-asset-group-to-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region in which the instance resides. You can call the https://help.aliyun.com/document_detail/118703.html operation to… |
| InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/118698.html operation to query the IDs of all Anti-DDoS… |
| AssetGroupList | string | yes | The information about the asset that you want to dissociate (JSON-encoded) |

### Queries the activation status of Simple Log Service for the current Alibaba Cloud account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/get-sls-open-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the Anti-DDoS Origin instance. For more information about the valid values of this parameter, see… |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. This parameter is empty by default,… |

### Queries Anti-DDoS Origin instances that have log analysis enabled
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/list-opened-access-log-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. By default, this parameter is empty,… |
| PageNumber | integer | no | The page number to return in a paging query. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries to return on each page in a paging query. Default value: 10, which indicates 10 entries per page |

### Queries mitigation policies
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/list-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| Name | string | no | The policy name |
| Type | string | no | The policy type. Valid values: default: the default mitigation policy. l3: the IP-specific mitigation policy. l4: the port-specific… |
| PageNo | integer | no | The page number of the current page in a paging query |
| PageSize | integer | no | The number of entries per page in a paging query. Default value: 10 |
| ProductType | string | no | The applicable product type. Valid values: ecs: queries the default policy applicable to ECS. slb: queries the default policy applicable… |

### Queries the associations of mitigation policies
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/list-policy-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| PolicyId | string | no | The policy ID |
| PolicyType | string | no | The policy type. Valid values: default: default mitigation policy. l3: IP-specific mitigation policy. l4: port-specific mitigation policy |
| IpPortProtocolList | string | no | The list of protected objects (JSON-encoded) |
| PageNo | integer | no | The page number of the current page in a paging query |
| PageSize | integer | no | The number of entries per page in a paging query. Default value: 10 |
| PortVersion | string | no | The version of the port-specific mitigation policy. Valid values: Not specified: queries the policy associations of the default surf DPI… |

### Queries all tags
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/list-tag-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region that you want to query |
| ResourceType | string | yes | The resource type. Set the value to INSTANCE |
| PageSize | integer | no | The number of entries per page. Valid values: 1 to 50. Default value: 10 |
| CurrentPage | integer | no | The page number. Pages start from page 1. Default value: 1 |
| ResourceGroupId | string | no | The resource group ID |

### Queries the relationship between Anti-DDoS Origin instances and tags
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter,… |
| RegionId | string | yes | The ID of the region where the Anti-DDoS Origin instance resides. You can call the https://help.aliyun.com/document_detail/118703.html… |
| ResourceType | string | yes | The type of the resource to query. Set the value to INSTANCE |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the… |
| ResourceId | string | no | The IDs of the Anti-DDoS Origin instances to query. The ResourceId parameter and the key-value pair for the Tag parameter cannot be left… |
| Tag | string | no | The key-value pair of the tag to query (JSON-encoded) |

### Modifies a mitigation policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/modify-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The policy ID |
| ActionType | integer | yes | The action type. Valid values: 10: modifies the name (Name is required). 11: modifies the blacklist timeout period (BlackIpListExpireAt is… |
| Name | string | no | The policy name |
| Content | string | no | The policy content (JSON-encoded) |
| PortVersion | string | no | The version of the port-specific mitigation policy. Valid values: Not specified: Modifies the default surf mitigation engine policy. 2:… |

### Modifies the content of a mitigation policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/modify-policy-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The policy ID |
| Name | string | no | The policy name |
| Content | string | no | The policy content (JSON-encoded) |
| PortVersion | string | no | The version of the port-specific mitigation policy. Valid values: Not specified: modifies the default surf mitigation engine policy. 2:… |

### Sets a remark for a single Anti-DDoS Origin instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/modify-remark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Anti-DDoS Origin instance for which you want to set a remark. You can call… |
| Remark | string | no | The remark for the Anti-DDoS Origin instance |
| ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter,… |
| RegionId | string | no | The region ID of the Anti-DDoS Origin instance. You can call https://help.aliyun.com/document_detail/118703.html to query all region IDs… |

### Changes the resource group to which a cloud resource belongs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/move-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The resource ID |
| ResourceGroupId | string | yes | The ID of the resource group to which you want to move the resource |
| ResourceType | string | yes | The resource type. Set the value to instance |
| ResourceRegionId | string | yes | The region ID of the resource |

### Releases a pay-as-you-go Anti-DDoS Origin instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/release-ddos-origin-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Anti-DDoS Origin instance that you want to release. You can call the https://help.aliyun.com/document_detail/118698.html… |

### Add tags to Anti-DDoS Origin instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. If you do not specify this parameter, the instance… |
| RegionId | string | yes | The ID of the region in which the instance resides. You can call the https://help.aliyun.com/document_detail/118703.html operation to… |
| ResourceType | string | yes | The type of the resource to which you want to add tags. Set the value to INSTANCE, which indicates instances |
| ResourceId | string | yes | The IDs of the instances to which you want to add tags. You can specify up to 51 IDs (JSON-encoded) |
| Tag | string | no | The tags to add. You can specify up to 21 tags (JSON-encoded) |

### Removes tags from Anti-DDoS Origin instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group |
| RegionId | string | yes | The ID of the region in which the instances reside |
| ResourceType | string | yes | The resource type. Set the value to INSTANCE |
| All | string | no | Specifies whether to remove all tags from the instances. Default value: No |
| ResourceId | string | yes | The IDs of the instances. Valid values of N: 0 to 49. You can specify up to 50 instances at a time. Example: ResourceId.0, ResourceId.1,… |
| TagKey | string | no | The keys of the tag that you want to remove. Valid values of N: 0 to 19. You can specify up to 20 tag keys at a time. Example: Tag.0.Key,… |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ddosbgp.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/add-ip" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Protection Package API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-ddosbgp/add-ip with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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