# Alibaba Cloud BGP-line Anti-DDoS Pro API > Alibaba Cloud BGP-line Anti-DDoS Pro API on Apizie: 184 endpoints (Adds IP addresses to the blacklist for an Anti-DDoS Pro instance, Adds whitelist IP addresses for an Anti-DDoS Pro or Anti-DDoS Premium instance, Associates an SSL certificate with a forwarding rule of a website service, Adds protected objects to a scenario-specific 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://apizie.tech/v1/cloud:aliyun-ddoscoo/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-ddoscoo` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/ddoscoo - Page: https://apizie.tech/api/cloud/aliyun-ddoscoo - OpenAPI: https://apizie.tech/api/cloud/aliyun-ddoscoo/openapi.json Alibaba Cloud OpenAPI for BGP-line Anti-DDoS Pro (ddoscoo, version 2020-01-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Adds IP addresses to the blacklist for an Anti-DDoS Pro instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/add-auto-cc-blacklist` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro instance. Call the DescribeInstanceIds operation to query the IDs of all Anti-DDoS Pro instances | | Blacklist | string | yes | The IP addresses to add to the blacklist. This is a JSON array. Each object in the array contains the following field: src: String.… | | ExpireTime | integer | yes | The expiration time for the blacklist entries, in seconds. Valid values: 300 to 604800 | ### Adds whitelist IP addresses for an Anti-DDoS Pro or Anti-DDoS Premium instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/add-auto-cc-whitelist` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance for which you want to add whitelist IP addresses. You can invoke… | | Whitelist | string | yes | The configuration of the whitelist IP addresses to add. This parameter is a string that is converted from a JSON array. Each element in… | | ExpireTime | integer | no | [Deprecated] This parameter is deprecated. This parameter specifies the validity period of blacklist IP addresses. Whitelist IP addresses… | ### Associates an SSL certificate with a forwarding rule of a website service `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/associate-web-cert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | yes | The domain name of the website service. The domain name must have a website forwarding rule configured. You can call… | | CertId | integer | no | The certificate ID. If you specify the certificate ID, you do not need to specify CertName, Cert, or Key. This parameter cannot be used… | | CertName | string | no | The certificate name. The name of the certificate to associate. This parameter must be used together with Cert and Key | | Cert | string | no | The public key of the certificate to associate. This parameter must be used together with CertName and Key. If you specify CertName, Cert,… | | Key | string | no | The private key of the certificate to associate. This parameter must be used together with CertName and Cert. If you specify CertName,… | | CertIdentifier | string | no | The global certificate ID, which is in the format of certificate ID + "-cn-hangzhou". For example, if the certificate ID is 123, set… | | CertRegion | string | no | The region where the certificate is stored. Valid values: cn-hangzhou and ap-southeast-1. Default value: cn-hangzhou | ### Adds protected objects to a scenario-specific policy `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/attach-scene-defense-object` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | PolicyId | string | yes | The policy ID. You can call https://help.aliyun.com/document_detail/159382.html to query all policy IDs | | ObjectType | string | yes | The object type. Set the value to Domain, which indicates a domain name | | Objects | string | yes | The protected objects to add. Separate multiple objects with commas (,) | ### Configures the switch and level of the Anti-DDoS Global Mitigation Policy mitigation policies `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-domain-security-profile` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | yes | The domain name of the website service. The domain name must have a website forwarding rule configured. You can call… | | Config | string | yes | The Anti-DDoS Global Mitigation Policy for Protection for Website Services. The structure is as follows: global_rule_mode: String type.… | | Cluster | string | no | Not in use | ### Configures an Anti-DDoS Global Mitigation Policy `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-l7-global-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | yes | The domain name of the website service to configure | | RuleAttr | string | yes | The action and switch settings for global template rules. The value is a string converted from a JSON struct array. The JSON struct… | ### Configures back-to-origin policies for website forwarding rules that have been created `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-l7-rs-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. This parameter is… | | Domain | string | yes | The domain name of the website whose forwarding rules you want to manage. The domain name must have website forwarding rules configured.… | | Policy | string | yes | The back-to-origin policy. The value is a character string that represents a JSON structure. The JSON structure contains the following… | | UpstreamRetry | integer | no | Specifies whether to enable back-to-origin retry. Valid values: 1: Enabled. 0: Disabled | ### Configures the persistent connection settings for back-to-origin requests of a domain name `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-l7-us-keepalive` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | no | The domain name of the website service. The domain name must have a website service forwarding rule configured. You can call… | | UpstreamKeepalive | string | yes | The persistent connection settings for back-to-origin requests of Anti-DDoS Proxy. The value is a string that represents a JSON struct.… | | DownstreamKeepalive | string | no | The idle timeout period of the persistent connection between the client and Anti-DDoS Proxy | ### Adds remarks to port forwarding rules `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-layer4-remark` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Listeners | string | yes | The port forwarding rules that you want to configure. This parameter is a string that is a transform of a JSON array. Each element in the… | ### Modifies the back-to-origin mode of a port forwarding rule (enables or disables origin redundancy) `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-layer4-rule-bak-mode` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | BakMode | string | yes | The back-to-origin mode. Valid values: 0: The default back-to-origin mode. Anti-DDoS Pro or Anti-DDoS Premium forwards service traffic to… | | Listeners | string | yes | The port forwarding rule to configure. This parameter is a string converted from a JSON array. Each element in the JSON array represents a… | ### Sets the primary and secondary origin server IP addresses for port forwarding rules `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-layer4-rule-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Listeners | string | yes | The port forwarding rules. This parameter is a string that represents a JSON array converted from a character string. Each element in the… | ### Configures location blacklist settings for an Anti-DDoS Pro or Anti-DDoS Premium instance area `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-network-region-block` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. You can call https://help.aliyun.com/document_detail/157459.html to query the… | | Config | string | yes | The configuration of the location blacklist, expressed as a JSON string with the following structure: RegionBlockSwitch: String type.… | ### Modifies the IP addresses of the origin server `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-network-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | NetworkRules | string | yes | The details of the port forwarding rules. The value is a JSON format character string that contains the following structure: InstanceId:… | ### Adds a UDP reflection attack attack prevention protection policy to filter specified reflection source ports `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-udp-reflect` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance to manage. You can invoke https://help.aliyun.com/document_detail/157459.html to… | | Config | string | yes | The configuration of the UDP reflection attack attack prevention protection policy to add. This parameter is a string that represents a… | | RegionId | string | no | The region ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. Valid values: cn-hangzhou (default): the Chinese mainland, which… | ### Creates or modifies a custom rule for frequency control (HTTP flood mitigation) of website services `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-web-ccrule-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | yes | The domain name of the website service. The domain name must have a website service forwarding rule configured. You can call… | | RuleList | string | yes | The configuration of the frequency control rule, expressed as a JSON-formatted string with the following structure: action: String type.… | | Expires | integer | no | The validity period of the rule. Unit: seconds. Default value: 0, which indicates that the rule is permanently effective | ### Sets the defense mode for frequency control (HTTP flood mitigation) of a website service `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-web-cctemplate` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. By default, this… | | Domain | string | yes | The domain name of the website service. The domain name must have a website forwarding rule configured. You can call… | | Template | string | yes | The defense mode for frequency control (HTTP flood mitigation). Valid values: default: Normal. gf_under_attack: Emergency. gf_sos_verify:… | ### Configures the IP blacklist and whitelist for a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/config-web-ip-set` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group in Resource Management to which the Anti-DDoS instance belongs. If you leave this parameter empty, the… | | Domain | string | yes | The domain name of the website. A website forwarding rule must be configured for the domain name. Call… | | BlackList | string | no | The list of IP addresses or address segments to add to the blacklist. You can add up to 200 IP addresses or address segments (JSON-encoded) | | WhiteList | string | no | The IP addresses or CIDR blocks for the whitelist. You can add up to 200 IP addresses or CIDR blocks (JSON-encoded) | ### Creates an asynchronous export task to export website forwarding rules, port forwarding rules, session… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/create-async-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. If this parameter is… | | TaskType | integer | yes | The type of the export task to create. Valid values: 1: Layer 4 export task. Exports port forwarding rules of the Anti-DDoS Pro or… | | TaskParams | string | yes | The task parameter information. The value is a JSON-formatted string. The required task parameters vary based on the value of TaskType. If… | ### Creates a forwarding rule for a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/create-domain-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | yes | The domain name of the website that you want to add to the Anti-DDoS Pro or Anti-DDoS Premium instance | | RsType | integer | yes | The address type of the origin server. Valid values: 0: IP address. 1: domain name. This parameter is suitable for scenarios in which… | | HttpsExt | string | no | The advanced HTTPS settings. This parameter takes effect only when the value of the ProxyType parameter includes https. The value is a… | | InstanceIds | string | yes | An array consisting of the IDs of instances that you want to associate (JSON-encoded) | | RealServers | string | yes | An array that consists of the addresses of origin servers (JSON-encoded) | | ProxyTypes | string | yes | The details about the protocol type and port number (JSON-encoded) | ### Creates port forwarding rules `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/create-network-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | NetworkRules | string | yes | The details of the port forwarding rules, expressed as a string in JSON format. The structure is as follows. InstanceId: String type,… | | IpMode | string | no | The IP forwarding mode. Valid values: v6tov4: indicates that the IP versions of the origin server and the client are the same. Requests… | ### Creates a port forwarding rule `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/create-port` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | FrontendPort | string | yes | The redirection port. Valid values: 0 to 65535 | | FrontendProtocol | string | yes | The forwarding protocol type. Valid values: tcp: TCP udp: UDP | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance to which the port forwarding rule belongs. You can call the… | | BackendPort | string | no | The origin server port. Valid values: 0 to 65535 | | RealServers | string | yes | The list of origin IP addresses (JSON-encoded) | | ProxyEnable | integer | no | Specifies whether to enable traffic redirection. Valid values: 0: disabled 1: enabled | | IpMode | string | no | The IP forwarding mode. Valid values: v6tov4: The IP versions of the origin server and the client are the same. IPv4 client requests are… | ### Creates a scenario-specific policy `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/create-scene-defense-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Name | string | yes | The policy name | | Template | string | yes | The policy template. Valid values: promotion: Important Activity template. bypass: full forwarding | | StartTime | integer | yes | The start time when the policy takes effect. This value is a UNIX timestamp. Unit: milliseconds | | EndTime | integer | yes | The end time when the policy takes effect. This value is a UNIX timestamp. Unit: milliseconds | ### Creates a scheduling rule for Sec-Traffic Manager `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/create-scheduler-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. By default, this… | | Rules | string | yes | The details of the general interaction rule. The value is a character string in JSON format. The structure is as follows: Type: the… | | RuleName | string | yes | The name of the rule | | RuleType | integer | yes | The type of the rule. Valid values: 2: tiered protection 3: cross-border acceleration 5: CDN or DCDN interaction 6: cloud service… | | Param | string | no | The details of the CDN interaction rule. The value is a character string in JSON format. The structure is as follows: ParamType: the type… | ### Adds tags to multiple Anti-DDoS Proxy instances at a time `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/create-tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the Anti-DDoS Proxy instance | | 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… | | ResourceType | string | yes | The type of the resource to which the tag belongs. Set the value to INSTANCE, which indicates an Anti-DDoS Pro instance | | ResourceIds | string | yes | The IDs of the Anti-DDoS Proxy instances to which you want to add tags (JSON-encoded) | | Tags | string | no | An array that consists of the tags to add (JSON-encoded) | ### Creates a forwarding rule for a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/create-web-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Proxy instance belongs in Resource Management. If you leave this parameter empty, the… | | Domain | string | yes | The domain name of the website to add to the Anti-DDoS Proxy instance for protection | | RsType | integer | yes | The address type of the origin server. Valid values: 0: IP address. 1: domain name. This value is typically used when a proxy service,… | | Rules | string | yes | The details of the forwarding rule, in a JSON string format. The value is an array of objects. Each object contains the following fields:… | | HttpsExt | string | no | The advanced HTTPS settings. This parameter takes effect only when the value of ProxyType includes https. This parameter is a JSON string.… | | DefenseId | string | no | The ID of the protection rule to associate. This parameter is used when an Alibaba Cloud service, such as Object Storage Service (OSS), is… | | InstanceIds | string | no | The IDs of the Anti-DDoS Proxy instances to associate (JSON-encoded) | ### Deletes an asynchronous export task `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-async-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | TaskId | integer | yes | The ID of the task that you want to delete. You can call the [DescribeAsyncTasks](~~DescribeAsyncTasks~~) operation to query the IDs of… | ### Removes IP addresses from the blacklist of an Anti-DDoS Pro or Anti-DDoS Premium instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-auto-cc-blacklist` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. Call https://help.aliyun.com/document_detail/157459.html to query the IDs of… | | QueryType | string | no | The QueryType | | Blacklist | string | yes | A JSON string that contains the IP addresses to remove from the blacklist. The string has the following structure: src: The IP address to… | ### Deletes whitelist IPs for an Anti-DDoS Pro or Anti-DDoS Premium instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-auto-cc-whitelist` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. You can call https://help.aliyun.com/document_detail/157459.html to query the… | | Whitelist | string | yes | The details of the whitelist IP, expressed as a JSON string with the following structure. src: String type, required, the whitelist IP | ### Deletes the specified website business forwarding rule `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-domain-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | yes | The domain name corresponding to the website business forwarding rule to be deleted | ### Deletes a port forwarding rule. You can delete only one port forwarding rule at a time `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-network-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | NetworkRule | string | yes | An array that consists of the information about the port forwarding rule. This parameter is a JSON string. The string contains the… | ### Deletes the specified port forwarding rule `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-port` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | FrontendPort | string | yes | The forwarding port. Valid values: 0 to 65535 | | FrontendProtocol | string | yes | The type of the forwarding protocol. Valid values: tcp udp | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance to which the port forwarding rule belongs. You can call the… | | BackendPort | string | no | The port of the origin server. Valid values: 0 to 65535 | | RealServers | string | no | An array that consists of the IP addresses of origin servers (JSON-encoded) | ### Deletes a scenario-specific custom policy `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-scene-defense-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | PolicyId | string | yes | The ID of the policy that you want to delete. You can call the https://help.aliyun.com/document_detail/159382.html operation to query the… | ### Deletes a scheduling rule of Sec-Traffic Manager `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-scheduler-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | RuleName | string | yes | The name of the scheduling rule that you want to delete | ### Removes tags from an Anti-DDoS Proxy (Chinese Mainland) instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the Anti-DDoS instance. The value is fixed to cn-hangzhou, which indicates the Chinese mainland | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS instance belongs in Resource Management. If you do not set this parameter, the… | | ResourceType | string | yes | The resource type. The value is fixed to INSTANCE, which indicates an Anti-DDoS instance | | All | string | no | Specifies whether to remove all tags from the resource. Valid values: true false (default) | | ResourceIds | string | yes | A list of IDs of the Anti-DDoS instances from which you want to remove tags (JSON-encoded) | | TagKey | string | no | A list of tag keys to remove (JSON-encoded) | ### Deletes custom frequency control rules of a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-web-ccrule-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | yes | The domain name of the website. A forwarding rule must be configured for the domain name. You can call the… | | RuleNames | string | no | The names of the rules that you want to delete | | Owner | string | no | The source of the rule. Valid values: manual (default): manually created. clover: automatically created. Specify this value when you want… | ### Deletes the custom rules of the Static Page Caching policy for a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-web-cache-custom-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.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 configure this parameter, the instance… | | Domain | string | yes | The domain name for which you want to delete the custom rules of the Static Page Caching policy. You can call the… | | RuleNames | string | yes | An array consisting of the names of the rules that you want to delete (JSON-encoded) | ### Deletes the accurate access control rules that are created for a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-web-precise-access-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | Domain | string | yes | The domain name of the website. A forwarding rule must be configured for the domain name. You can call the… | | RuleNames | string | yes | An array that consists of the names of rules to delete (JSON-encoded) | ### Deletes a forwarding rule of a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/delete-web-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | Domain | string | yes | The domain name of the website from which you want to delete the forwarding rule. A forwarding rule must be configured for the domain… | ### Queries detailed information about asynchronous export tasks, including task ID, start and end times,… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-async-tasks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The resource group ID of the Anti-DDoS instance in Resource Management. If this parameter is not specified, the default resource group is… | | PageNumber | integer | yes | The page number for the paged query | | PageSize | integer | yes | The number of asynchronous export tasks to return on each page for the paged query | ### Queries the peak QPS of DDoS attacks within a specified time period `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-attack-analysis-max-qps` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | StartTime | integer | yes | The start time of the query. The value is a UNIX timestamp. Unit: seconds | | EndTime | integer | yes | The end time of the query. The value is a UNIX timestamp. Unit: seconds | | Ip | string | no | The IP address of the Anti-DDoS Proxy instance to query | ### Queries the blacklisted IP addresses for Anti-DDoS Pro or Anti-DDoS Premium instances `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-auto-cc-blacklist` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. You can call the https://help.aliyun.com/document_detail/157459.html operation… | | QueryType | string | no | The source of the blacklisted IP addresses to query. Valid values: manual: Manually added. auto: Automatically added | | KeyWord | string | no | The prefix of the source IP address used for keyword-based queries. The prefix must be more than three characters in length | | PageNumber | integer | yes | The page number to return for a paged query. For example, to query the first page, set the value to 1 | | PageSize | integer | yes | The number of entries to return on each page | ### Queries the numbers of IP addresses in the IP address whitelist and IP address blacklist of an Anti-DDoS… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-auto-cc-list-count` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the instance. You can call the DescribeInstanceIds operation to query the IDs of all instances | | QueryType | string | no | The mode of how an IP address is added to the whitelist or blacklist. Valid values: manual: manually added auto: automatically added | ### Queries IP addresses in the IP address whitelist of an Anti-DDoS Proxy instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-auto-cc-whitelist` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/157459.html operation to query the IDs of all instances | | KeyWord | string | no | The keyword for the query. This keyword is used to specify the prefix of the source IP address that you want to query. The keyword must be… | | PageNumber | integer | yes | The number of the page to return. For example, to query the returned results on the first page, set the value to 1 | | PageSize | integer | yes | The number of entries to return on each page | ### Queries the back-to-origin CIDR blocks of Anti-DDoS Proxy `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-back-source-cidr` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | Line | string | no | The Internet service provider (ISP) line that you want to query | | IpVersion | string | no | The IP version of the back-to-origin CIDR blocks. Ipv4 Ipv6 | ### Queries the blackhole filtering status of an Anti-DDoS Proxy instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-blackhole-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceIds | string | yes | The ID of the Anti-DDoS Proxy instance. You can call https://help.aliyun.com/document_detail/157459.html to query the IDs of all Anti-DDoS… | ### Queries the near-origin traffic diversion configurations of an Anti-DDoS Pro and Anti-DDoS Premium instance… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-block-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro and Anti-DDoS Premium instance belongs in Resource Management. If you do not set… | | InstanceIds | string | yes | The IDs of the Anti-DDoS Pro and Anti-DDoS Premium instances to query for near-origin traffic diversion configurations. You can invoke… | ### Describes the CDN interaction rule configurations for a specified domain name `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-cdn-linkage-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS instance belongs in Resource Management. If you leave this parameter empty, the… | | Domain | string | no | The domain name of your website. The domain name must be added to your Anti-DDoS instance. Call… | | PageNumber | integer | yes | The number of the page to return for a paged query | | PageSize | integer | yes | The number of entries to return on each page for a paged query | ### Queries all certificates that are available for a domain name. This operation does not query the certificate… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-certs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS instance belongs in Resource Management. If you leave this parameter empty, the… | | Domain | string | no | The domain name of your website. A website forwarding rule must be configured for the domain name. You can call the… | ### Queries the CNAME reuse information about websites `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-cname-reuses` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Proxy instance belongs in Resource Management. This parameter is empty by default,… | | Domains | string | yes | The domain names of the websites. You can specify the domain names of up to 200 websites. A forwarding rule must be configured for the… | ### Queries attack events on Anti-DDoS Pro or Anti-DDoS Premium instances `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-ddo-sevents` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group in Resource Management to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs. By default, this… | | EndTime | integer | no | The end of the time range to query. This is a UNIX timestamp. Unit: seconds. The timestamp must be on the minute | | StartTime | integer | yes | The beginning of the time range to query. This is a UNIX timestamp. Unit: seconds. The timestamp must be on the minute | | PageSize | integer | yes | The number of entries to return on each page | | PageNumber | integer | yes | The number of the page to return. For example, to query the first page, set this parameter to 1 | | InstanceIds | string | yes | The IDs of the Anti-DDoS Pro or Anti-DDoS Premium instances. Call https://help.aliyun.com/document_detail/157459.html to query the IDs of… | ### Queries the list of DDoS attack events `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-ddos-all-event-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | EventType | string | no | The type of DDoS attack event to query. Valid values: web-cc: web resource exhaustion attack. cc: connection flood attack. defense:… | | StartTime | integer | yes | The beginning of the time range to query. DDoS attack events that occurred after StartTime are queried. Specify a UNIX timestamp. Unit:… | | EndTime | integer | yes | The end of the time range to query. DDoS attack events that occurred before EndTime are queried. Specify a UNIX timestamp. Unit: seconds.… | | PageNumber | integer | yes | The page number to return in a paging query | | PageSize | integer | yes | The number of attack events to return on each page in a paging query | | Ip | string | no | The IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance to query | ### Queries the source region details of a volumetric attack `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-ddos-event-area` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | EventType | string | yes | The event type of the attack event to query. Valid values: defense: traffic scrubbing events for volumetric attacks. blackhole: blackhole… | | StartTime | integer | yes | The start timestamp of the event to query. Unit: seconds. You can call https://help.aliyun.com/document_detail/188604.html to query the… | | Ip | string | yes | The attacked IP Address of Anti-DDoS Proxy instance of Anti-DDoS Pro and Anti-DDoS Premium | | Range | integer | no | The number of data entries to return. Unit: entries | ### Queries the attack type details of a volumetric attack `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-ddos-event-attack-type` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | EventType | string | yes | The type of the attack event to query. Valid values: defense: volumetric attack scrubbing events. blackhole: volumetric attack blackhole… | | StartTime | integer | yes | The start timestamp of the event to query. Unit: seconds. You can call https://help.aliyun.com/document_detail/188604.html to query the… | | Ip | string | yes | The attacked IP Address of Anti-DDoS Proxy instance | ### Queries the Internet service provider (ISP) information of attack sources for a volumetric attack `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-ddos-event-isp` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | EventType | string | yes | The event type of the attack event to query. Valid values: defense: traffic scrubbing events for volumetric attacks. blackhole: blackhole… | | StartTime | integer | yes | The start timestamp of the event to query. Unit: seconds. You can call https://help.aliyun.com/document_detail/473646.html to query the… | | Ip | string | yes | The attacked IP Address of Anti-DDoS Proxy instance | | Range | integer | no | The number of data entries to return | ### Queries the peak attack throughput of volumetric attacks (bit/s), connection flood attacks (CPS), and web… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-ddos-event-max` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | StartTime | integer | yes | The start timestamp of the query. Unit: seconds | | EndTime | integer | yes | The end timestamp of the query. Unit: seconds | | Ip | string | no | The IP address of the Anti-DDoS Proxy instance that is under attack | ### Queries the details of attack source IP addresses for a specific volumetric attack event `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-ddos-event-src-ip` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | EventType | string | yes | The type of the attack event to query. Valid values: defense: traffic scrubbing events for volumetric attacks. blackhole: blackhole… | | StartTime | integer | yes | The start timestamp of the event to query. Unit: seconds. You can call https://help.aliyun.com/document_detail/188604.html to query the… | | Ip | string | yes | The attacked IP Address of Anti-DDoS Proxy instance | | Range | integer | yes | The number of attack source IP addresses to return. The IP addresses are sorted by attack traffic in descending order. Default value: 5 | ### Queries the statistics on advanced mitigation sessions of an Anti-DDoS Proxy (Outside Chinese Mainland)… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-defense-count-statistics` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.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 configure this parameter, the instance… | ### Queries the advanced mitigation logs of Anti-DDoS Premium `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-defense-records` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS instance belongs. If you leave this parameter empty, the instance belongs to the… | | InstanceId | string | no | The ID of the Anti-DDoS instance. Call https://help.aliyun.com/document_detail/157459.html to query the IDs of all Anti-DDoS instances | | StartTime | integer | yes | The beginning of the time range to query. This is a UNIX timestamp. Unit: milliseconds. The time span of the query cannot exceed 90 days | | EndTime | integer | yes | The end of the time range to query. This is a UNIX timestamp. Unit: milliseconds. The time span of the query cannot exceed 90 days | | PageNumber | integer | yes | The number of the page to return. For example, to query the first page, set this parameter to 1 | | PageSize | integer | yes | The number of entries to return on each page. Maximum value: 50 | ### Queries the number of request packets received by the destination ports of the attacked IP address that is… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-destination-port-event` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Region | string | yes | The region in which your service is deployed. Valid values: cn: a region in the Chinese mainland. cn-hongkong: a region outside the… | | EventType | string | yes | The type of the attack event that you want to query. Valid values: defense: attack events that trigger traffic scrubbing. blackhole:… | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | Ip | string | yes | The IP address of the attacker | | Range | integer | yes | The number of destination ports to return. The ports are sorted in descending order of the number of received request packets. By default,… | ### Queries the attack events launched against a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-attack-events` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | EndTime | integer | yes | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that… | | Domain | string | no | The domain name of the website. A forwarding rule must be configured for the domain name. You can call the… | | PageNumber | integer | yes | The number of the page to return. For example, to query the returned results on the first page, set the value to 1 | | PageSize | integer | yes | The number of entries to return on each page | ### Queries the bandwidths of a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-bps` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Region | string | yes | The region in which your service is deployed. Valid values: cn: a region in the Chinese mainland. cn-hongkong: a region outside the… | | Domain | string | no | The domain name of the website. A forwarding rule must be configured for the domain name. You can call the… | | StartTime | integer | yes | The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | EndTime | integer | yes | The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that… | | Interval | integer | yes | The interval for returning data. Unit: seconds. Valid values are 300, 3600, and 86400. If the time span between StartTime and EndTime is… | ### Queries the status of the CC protection feature for the specified domain names `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-cc-protect-switch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro instance belongs in Resource Management. If you do not specify this parameter, the… | | Domains | string | yes | The domain names of the websites. You can specify up to five domain names. A website forwarding rule must be configured for the domain… | ### Queries the HTTP/2.0 fingerprint information of a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-h2-fingerprint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | no | The domain name of the website. You can call https://help.aliyun.com/document_detail/91724.html to query the domain names of all websites… | | StartTime | integer | yes | The start time of the query. The value is a UNIX timestamp. Unit: seconds. The time must be on the minute | | EndTime | integer | no | The end time of the query. The value is a UNIX timestamp. Unit: seconds. The time must be on the minute | | Limit | integer | yes | The number of entries to return | | QueryType | string | no | The source of the queried data. Valid values: block: statistics on blocked access sources. visit: statistics on normal access sources | ### Queries the attack overview of a website, such as the peak HTTP and HTTPS traffic `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-overview` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | EndTime | integer | no | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you leave this parameter unspecified, the current… | | Domain | string | no | The domain name of the website that you want to query. If you leave this parameter unspecified, the statistics on all domain names are… | ### Queries the statistics on the queries per second (QPS) of a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-qpslist` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | EndTime | integer | yes | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that… | | Interval | integer | yes | The interval for returning data. Unit: seconds | | Domain | string | no | The domain name of the website. If you do not specify this parameter, the statistics on the QPS of all domain names are queried. A… | ### Describes the forwarding rule configuration for a web service `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | no | The domain name to query | | QueryDomainPattern | string | no | The matching pattern for the query. Valid values: fuzzy (default): Specifies a fuzzy search. exact: Specifies an exact match | | PageNumber | integer | no | The number of the page to return. The default value is 1 | | PageSize | integer | no | The number of forwarding rules per page | | InstanceIds | string | no | The IDs of the Anti-DDoS Pro instances to query (JSON-encoded) | ### Queries the statistics on HTTP status codes of a website within a specified period `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-status-code-count` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Proxy instance belongs in Resource Management. This parameter is empty by default,… | | StartTime | integer | yes | The start time of the query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that is… | | EndTime | integer | yes | The end time of the query. The value is a timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that is accurate to… | | Domain | string | no | The domain name of the website to query. If you leave this parameter unspecified, the statistics on all domain names are queried. The… | ### Queries the response status code statistics information for website services `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-status-code-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. By default, this… | | StartTime | integer | yes | The beginning of the time range to query. Specify a UNIX timestamp. Unit: seconds. The value must be on the exact minute | | EndTime | integer | no | The end of the time range to query. Specify a UNIX timestamp. Unit: seconds. The value must be on the exact minute | | Interval | integer | yes | The time interval between consecutive data entries returned. Unit: seconds. This parameter specifies how frequently a query result is… | | Domain | string | no | The domain name of the website service. You can invoke https://help.aliyun.com/document_detail/91724.html to query the domain names of all… | | QueryType | string | yes | The source of the query data. Valid values: gf: Anti-DDoS Pro or Anti-DDoS Premium response data. upstream: origin server response data | ### Queries the peak queries per second (QPS) data of website services within a specified time period, including… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-top-attack-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro and Anti-DDoS Premium instance belongs in Resource Management. This parameter is… | | StartTime | integer | yes | The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds. The value must be on the hour or half hour | | EndTime | integer | yes | The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. The value must be on the hour or half hour | | Interval | integer | no | The time granularity of the query data. Unit: seconds. Valid values: 300, 3600, 14400, 28800, and 86400. If you do not specify this… | ### Queries the top N client fingerprints for websites `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-top-fingerprint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Region | string | yes | The service region. Valid values: cn: the Chinese mainland. cn-hongkong: outside the Chinese mainland | | Domain | string | no | The domain name of the website service. The domain name must be configured with a traffic forwarding rule for the website service. You can… | | StartTime | integer | yes | The start time of the query. The time is in the UNIX timestamp format. Unit: seconds. The time must be specified to the exact minute | | EndTime | integer | yes | The end time of the query. The time is in the UNIX timestamp format. Unit: seconds. The time must be specified to the exact minute | | Limit | integer | yes | The number of entries to return | | Interval | integer | yes | The time interval at which data is returned. Unit: seconds. This parameter specifies the interval between two consecutive data points | | QueryType | string | no | The source of the queried data. Valid values: block: statistics on blocked access sources. visit: statistics on normal access sources | ### Queries the top N HTTP methods for websites `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-top-http-method` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Region | string | yes | The service region. Valid values: cn: the Chinese mainland. cn-hongkong: outside the Chinese mainland | | Domain | string | no | The domain name of the website service. The domain name must have a website service forwarding rule configured. You can call… | | StartTime | integer | yes | The start time of the query. The value is a UNIX timestamp in seconds. The time must be on the hour | | EndTime | integer | yes | The end time of the query. The value is a UNIX timestamp in seconds. The time must be on the hour | | Limit | integer | yes | The number of entries to return | | QueryType | string | no | The source of the queried data. Valid values: block: statistics on blocked access sources. visit: statistics on normal access sources | ### Queries the top N referers for a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-top-referer` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Region | string | yes | The service region. Valid values: cn: the Chinese mainland. cn-hongkong: outside the Chinese mainland | | Domain | string | no | The domain name of the website service. The domain name must be configured with a traffic forwarding rule for website services. You can… | | StartTime | integer | yes | The start time of the query. The value is a UNIX timestamp in seconds. The time must be an exact minute | | EndTime | integer | yes | The end time of the query. The value is a UNIX timestamp in seconds. The time must be an exact minute | | Limit | integer | yes | The number of entries to return | | QueryType | string | no | The source of the queried data. Valid values: block: statistics on blocked access sources. visit: statistics on normal access sources | ### Queries the top user agents for a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-top-user-agent` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Region | string | yes | The service region. Valid values: cn: the Chinese mainland. cn-hongkong: outside the Chinese mainland | | Domain | string | no | The domain name of the website. A traffic forwarding rule for website services must be configured for the domain name. You can call… | | StartTime | integer | yes | The start time of the query. The value is a UNIX timestamp. Unit: seconds. The time must be exact to the minute | | EndTime | integer | yes | The end time of the query. The value is a UNIX timestamp. Unit: seconds. The time must be exact to the minute | | Limit | integer | yes | The number of entries to return | | QueryType | string | no | The source of the queried data. Valid values: block: statistics on blocked access sources visit: statistics on normal access sources | ### Queries the distribution of request source countries for website services within a specified time period `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-view-source-countries` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. This parameter is… | | StartTime | integer | yes | The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds. The value must be on the hour or half hour | | EndTime | integer | yes | The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. The value must be on the hour or half hour | | Domain | string | no | The domain name of the website service. The domain name must have a website service forwarding rule configured. You can call… | ### Queries the distribution of request sources by province in China for website services within a specified… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-view-source-provinces` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. This parameter is… | | StartTime | integer | yes | The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds. The value must be on the hour or half hour | | EndTime | integer | yes | The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. The value must be on the hour or half hour | | Domain | string | no | The domain name of the website service. The domain name must have a website service forwarding rule configured. You can call… | ### Queries the top N URLs that require the longest time to respond to requests within a specified period of time `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-view-top-cost-time` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | EndTime | integer | yes | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that… | | Domain | string | no | The domain name of the website. A forwarding rule must be configured for the domain name. You can call the… | | Top | integer | yes | The number of URLs to query. Valid values: 1 to 100 | ### Queries the top N most visited URLs for website services within a specified time period `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domain-view-top-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. This parameter is… | | StartTime | integer | yes | The beginning of the time range to query. Specify a UNIX timestamp. Unit: seconds. The value must be on the exact minute | | EndTime | integer | yes | The end of the time range to query. Specify a UNIX timestamp. Unit: seconds. The value must be on the exact minute | | Domain | string | no | The domain name of the website service. The domain name must have a website service forwarding rule configured. You can invoke… | | Top | integer | yes | The number of URLs to return. Valid values: 1 to 100 | | Inerval | integer | no | The step size for returning data, in seconds. This parameter specifies the interval at which a result is returned. The supported step size… | ### Queries domain names for which forwarding rules are created `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-domains` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | InstanceIds | string | no | The ID of the instance that you want to query. You can call the https://help.aliyun.com/document_detail/157459.html operation to query the… | ### Queries the available burstable protection bandwidth specifications for an Anti-DDoS Pro and Anti-DDoS… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-elastic-bandwidth-spec` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. You can invoke https://help.aliyun.com/document_detail/157459.html to query the… | ### Retrieves the elastic QPS time-series data for an Anti-DDoS instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-elastic-qps` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Region | string | yes | The service region. Valid values: cn: Chinese mainland. cn-hongkong: Outside Chinese mainland | | Ip | string | no | The IP address of the Anti-DDoS instance to query | | StartTime | integer | yes | The start of the query time range, specified as a UNIX timestamp in seconds. The timestamp must be the start of a minute | | EndTime | integer | yes | The end of the query time range, specified as a UNIX timestamp in seconds. The timestamp must be the start of a minute | | Interval | string | no | The sampling interval, in seconds. The value must be a multiple of 60. The default value is 60 | ### Queries the burstable QPS details of an Anti-DDoS Proxy instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-elastic-qps-record` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | StartTime | integer | yes | The beginning of the time range to query. The value is a timestamp. Unit: milliseconds | | EndTime | integer | yes | The end of the time range to query. The value is a timestamp. Unit: milliseconds | | Ip | string | yes | The IP address of the Anti-DDoS Proxy instance to query | ### Queries the custom headers for a domain name `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-headers` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group in Resource Management to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs. This parameter is… | | Domain | string | yes | The domain name for which to query custom headers. You can call the https://help.aliyun.com/document_detail/91724.html operation to query… | ### Queries the Layer 4 or Layer 7 health check configurations of a port forwarding rule `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-health-check-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | NetworkRules | string | yes | The information about the port forwarding rule. This parameter is a JSON string. The string contains the following fields: InstanceId: the… | ### Queries the health status of an origin server `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-health-check-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | NetworkRules | string | yes | An array that consists of the details of the port forwarding rule. This parameter is a JSON string. The string contains the following… | ### Queries the IP address and line information of an Anti-DDoS Pro or Anti-DDoS Premium instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-instance-details` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceIds | string | yes | The IDs of the Anti-DDoS Pro or Anti-DDoS Premium instances to query (JSON-encoded) | ### Queries the information about Anti-DDoS Pro and Anti-DDoS Premium instances `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-instance-ext` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | no | The ID of the instance. You can call the https://help.aliyun.com/document_detail/157459.html operation to query the IDs of all instances | | PageNumber | string | no | The number of the page. For example, to query the returned results on the first page, set the value to 1 | | PageSize | string | no | The number of entries per page | ### Queries the IDs, editions, remarks, and IP types of Anti-DDoS Pro or Anti-DDoS Premium instances `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-instance-ids` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. If you do not… | | Edition | integer | no | The edition of the Anti-DDoS Pro or Anti-DDoS Premium instance to query. Valid values: 0: Anti-DDoS Pro or Anti-DDoS Premium (outside the… | | InstanceIds | string | no | The IDs of the Anti-DDoS Pro or Anti-DDoS Premium instances to query. Maximum value of N: 200 (JSON-encoded) | ### Queries the specifications of Anti-DDoS Pro or Anti-DDoS Premium instances `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-instance-specs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceIds | string | yes | The IDs of the Anti-DDoS Pro or Anti-DDoS Premium instances to query (JSON-encoded) | ### Queries the statistics on one or more Anti-DDoS Proxy instances, such as the numbers of protected domain… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-instance-statistics` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceIds | string | yes | The ID of the instance that you want to query. You can call the https://help.aliyun.com/document_detail/157459.html operation to query the… | ### Queries the status of a specified Anti-DDoS Pro or Anti-DDoS Premium instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-instance-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance that you want to query. You can call the… | | ProductType | integer | yes | The type of the Anti-DDoS Pro or Anti-DDoS Premium instance that you want to query. Valid values: 1: an Anti-DDoS Proxy (Chinese Mainland)… | ### Queries the details of Anti-DDoS Pro or Anti-DDoS Premium instances `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. If you do not… | | PageNumber | string | yes | The page number for paging | | PageSize | string | yes | The number of instances per page for paging. Valid values: 1 to 50 | | Ip | string | no | The IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance to query | | Remark | string | no | The remark of the Anti-DDoS Pro or Anti-DDoS Premium instance to query. Fuzzy match is supported | | Edition | integer | no | The mitigation plan edition of the Anti-DDoS Pro or Anti-DDoS Premium instance to query. Valid values: 0: Anti-DDoS Pro and Anti-DDoS… | | Enabled | integer | no | The service traffic forwarding status of the Anti-DDoS Pro or Anti-DDoS Premium instance to query. Valid values: 0: Service traffic… | | ExpireStartTime | integer | no | The earliest expiration time of the Anti-DDoS Pro or Anti-DDoS Premium instances to query. This means that only instances whose expiration… | | ExpireEndTime | integer | no | The latest expiration time of the Anti-DDoS Pro or Anti-DDoS Premium instances to query. This means that only instances whose expiration… | | InstanceIds | string | no | The IDs of the Anti-DDoS Pro or Anti-DDoS Premium instances to query. You can specify up to 200 Anti-DDoS Pro or Anti-DDoS Premium… | | Status | string | no | The statuses of the Anti-DDoS Pro or Anti-DDoS Premium instances to query. You can specify up to 2 Anti-DDoS Pro or Anti-DDoS Premium… | | Tag | string | no | The tags attached to the Anti-DDoS Pro or Anti-DDoS Premium instances to query (JSON-encoded) | ### Queries the Anti-DDoS Global Mitigation Policy `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-l7-global-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | yes | The domain name of the website service to operate on | | Lang | string | no | The language type for the request and response messages. Valid values: zh: Chinese. en: English | ### Queries the back-to-origin policies for the forwarding rule of a website `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-l7-rs-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | Domain | string | yes | The domain name of the website to query. A forwarding rule must be configured for the domain name. You can call the… | | RealServers | string | no | An array that consists of N addresses of origin servers to query. The maximum value of N is 200. You can specify up to 200 addresses… | ### Queries the back-to-origin keep-alive connection settings for a domain name `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-l7-us-keepalive` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Domain | string | no | The domain name of the website service. The domain name must have a traffic forwarding rule configured for the website service. You can… | ### Queries the back-to-origin settings of a port forwarding rule `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-layer4-rule-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Listeners | string | yes | The port forwarding rule that you want to query. This parameter is a string that consists of JSON arrays. Each element in a JSON array… | ### Checks whether a Logstore is created for Anti-DDoS Proxy `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-log-store-exist-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | ### Queries the Location Blacklist configuration for an Anti-DDoS Pro or Anti-DDoS Premium instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-network-region-block` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. You can call https://help.aliyun.com/document_detail/157459.html to query the… | ### Queries the protection settings of port forwarding rules for non-website services, including session… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-network-rule-attributes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | NetworkRules | string | yes | The port forwarding rules to query. This parameter is a JSON string with the following structure: InstanceId: String type. Required. The… | ### Queries port forwarding rules `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-network-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. You can call the https://help.aliyun.com/document_detail/157459.html operation… | | ForwardProtocol | string | no | The forwarding protocol. Valid values: tcp udp | | FrontendPort | integer | no | The redirection port | | PageNumber | integer | yes | The page number to return for a paginated query. For example, to query the first page of results, set the value to 1 | | PageSize | integer | yes | The number of entries to return on each page | ### Queries the operation logs of Anti-DDoS Pro and Anti-DDoS Premium (the Chinese mainland) `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-op-entities` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro and Anti-DDoS Premium instance belongs in Resource Management. This parameter is… | | EntityType | integer | no | The type of the operation object used to filter results. Valid values: 1: IP Address of Anti-DDoS Proxy instance 2: Anti-DDoS Pro and… | | EntityObject | string | no | The operation object used to filter results | | StartTime | integer | yes | The beginning of the time range to query. This value is a UNIX timestamp. Unit: milliseconds. The time range cannot exceed 30 days | | EndTime | integer | yes | The end of the time range to query. This value is a UNIX timestamp. Unit: milliseconds. The time range cannot exceed 30 days | | PageNumber | integer | yes | The page number to return in a paging query. For example, to query the first page, set the value to 1 | | PageSize | integer | yes | The number of entries to return on each page. Maximum value: 50 | ### Queries the port forwarding rules created for an Anti-DDoS Pro or Anti-DDoS Premium instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance to query. You can call the https://help.aliyun.com/document_detail/157459.html… | | FrontendProtocol | string | no | The forwarding protocol type to query. Valid values: tcp: TCP. udp: UDP | | FrontendPort | integer | no | The forwarding port to query. Valid values: 0 to 65535 | | PageNumber | integer | no | The page number to return in a paged query. For example, to query the first page of results, set the value to 1 | | PageSize | integer | no | The number of records to return on each page | ### Queries the peak attack traffic bandwidth and peak attack traffic packet rates of one or more Anti-DDoS Pro… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port-attack-max-flow` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.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 configure this parameter, the instance… | | EndTime | integer | yes | The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that… | | StartTime | integer | yes | The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | InstanceIds | string | yes | The IDs of the Anti-DDoS Proxy instances to query (JSON-encoded) | ### Queries the configurations of the Intelligent Protection policy for non-website services `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port-auto-cc-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | InstanceIds | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/157459.html operation to query the IDs of all instances… | ### The statistics on the connections established over the ports of one or more Anti-DDoS Pro or Anti-DDoS… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port-conns-count` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | EndTime | integer | yes | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that… | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | Port | string | no | The number of port that you want to query. If you do not specify this parameter, all ports are queried | | InstanceIds | string | yes | An array that consists of the IDs of instances. You can call the https://help.aliyun.com/document_detail/157459.html operation to query… | ### Queries the connections established over the ports of one or more Anti-DDoS Proxy instances `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port-conns-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | | EndTime | integer | yes | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that… | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | Interval | integer | yes | The interval for returning data. Unit: seconds | | Port | string | no | The number of port that you want to query. If you do not specify this parameter, all ports are queried | | InstanceIds | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/157459.html operation to query the IDs of all instances… | ### Queries the traffic data list of an Anti-DDoS Pro and Anti-DDoS Premium instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port-flow-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro and Anti-DDoS Premium instance belongs in Resource Management. By default, this… | | EndTime | integer | yes | The end time of the query. Specify the value as a UNIX timestamp. Unit: seconds. The value must be on the minute | | StartTime | integer | yes | The start time of the query. Specify the value as a UNIX timestamp. Unit: seconds. The value must be on the minute | | Interval | integer | yes | The interval at which data is returned. Unit: seconds. The supported interval values vary based on the query time range (determined by… | | InstanceIds | string | yes | The ID of the Anti-DDoS Pro and Anti-DDoS Premium instance (JSON-encoded) | ### Queries the peak connection information of ports on an Anti-DDoS Pro or Anti-DDoS Premium instance `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port-max-conns` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. This parameter is… | | EndTime | integer | yes | The end time of the query. This value is a UNIX timestamp. Unit: seconds. The value must be on the minute | | StartTime | integer | yes | The start time of the query. This value is a UNIX timestamp. Unit: seconds. The value must be on the minute | | InstanceIds | string | yes | The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. You can invoke https://help.aliyun.com/document_detail/157459.html to query the… | ### Queries the areas and countries from which requests are sent to one or more Anti-DDoS Pro or Anti-DDoS… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port-view-source-countries` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Proxy instance belongs in Resource Management. This parameter is empty by default,… | | EndTime | integer | yes | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that… | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | InstanceIds | string | yes | The IDs of the Anti-DDoS Proxy instances to query (JSON-encoded) | ### Queries the distribution of request source ISPs for an Anti-DDoS Pro or Anti-DDoS Premium instance within a… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port-view-source-isps` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. If you do not set… | | EndTime | integer | yes | The end time of the request data to query. Specify a UNIX timestamp. Unit: seconds. The value must be on the minute | | StartTime | integer | yes | The start time of the request data to query. Specify a UNIX timestamp. Unit: seconds. The value must be on the minute | | InstanceIds | string | yes | The IDs of the Anti-DDoS Pro or Anti-DDoS Premium instances to query (JSON-encoded) | ### Queries the administrative regions in China from which requests are sent to one or more Anti-DDoS Pro or… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-port-view-source-provinces` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Proxy instance belongs in Resource Management. This parameter is empty by default,… | | EndTime | integer | no | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you do not configure this parameter, the current… | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | InstanceIds | string | yes | The IDs of the Anti-DDoS Proxy instances to query (JSON-encoded) | ### Queries the protected objects of a scenario-specific custom policy `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-scene-defense-objects` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | PolicyId | string | yes | The ID of the policy that you want to query. You can call the https://help.aliyun.com/document_detail/159382.html operation to query the… | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. If you do not configure this parameter, the instance… | ### Queries the detailed configurations of scenario-specific policies `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-scene-defense-policies` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Template | string | no | The templatetype used by the policy that you want to query. Valid values: promotion: Important Activity template. bypass: full forwarding… | | Status | string | no | The status of the policy that you want to query. Valid values: 0: disabled. 1: pending activation. 2: active. 3: expired | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. If you do not… | ### Queries the scheduling rules of a traffic scheduler `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-scheduler-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. By default, this… | | RuleName | string | no | The name of the rule | | PageNumber | integer | no | The page number to return for a paged query. For example, to query the first page of results, set the value to 1 | | PageSize | integer | yes | The number of entries to return on each page | ### Queries the destination rate limit events `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-sla-event-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | Region | string | yes | The type of the service Valid values: cn: Anti-DDoS Pro cn-hongkong: Anti-DDoS Premium | | Ip | string | no | The IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance | | StartTime | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time… | | EndTime | integer | yes | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that… | | PageSize | integer | no | The number of entries per page | | Page | integer | no | The page number | ### Queries whether Anti-DDoS Proxy is authorized to access Simple Log Service `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-sls-auth-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | ### Queries the log store information of Anti-DDoS Pro or Anti-DDoS Premium, such as log storage capacity and… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-sls-logstore-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. This parameter is… | ### Checks whether Simple Log Service is activated `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-sls-open-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates… | ### Queries whether Anti-DDoS Proxy are authorized to access other cloud services `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-sts-grant-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group to which the Anti-DDoS Proxy instance belongs in Resource Management. If you do not specify this parameter,… | | Role | string | yes | The name of the RAM role that you want to query. The value is fixed as AliyunDDoSCOODefaultRole, which indicates the default role of… | ### Queries the billing details of burstable clean bandwidth `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-system-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | EntityType | integer | no | The type of system logs to query. The value is fixed at 20, which indicates the billing logs of burstable clean bandwidth. You must set… | | EntityObject | string | no | The IP address of the Anti-DDoS instance to query. You can call https://help.aliyun.com/document_detail/91490.html to query the IP… | | StartTime | integer | yes | The start time to query bills of burstable clean bandwidth that are generated after the specified time. This value is a timestamp in… | | EndTime | integer | yes | The end time to query bills of burstable clean bandwidth that are generated before the specified time. This value is a timestamp in… | | PageNumber | integer | yes | The page number of the returned page | | PageSize | integer | yes | The number of logs to return on each page | ### Queries all tag keys and the number of Anti-DDoS Proxy (Chinese Mainland) instances to which each tag key is… `POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/describe-tag-keys` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ddoscoo.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the instance. Set the value to cn-hangzhou, which indicates an Anti-DDoS Proxy (Chinese Mainland) instance | | ResourceGroupId | string | no | The ID of the resource group to which the instance belongs in Resource Management. If you do not configure this parameter, the instance… | | ResourceType | string | yes | The type of the resource to which the tag belongs. Set the value to INSTANCE, which indicates an Anti-DDoS Pro instance | | PageSize | integer | no | The number of entries to return on each page. Default value: 10 | | PageNumber | integer | no | The number of the page to return. Default value: 1 | …and 64 more. See the OpenAPI spec. ## Example ``` curl "https://apizie.tech/v1/cloud:aliyun-ddoscoo/add-auto-cc-blacklist" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud BGP-line Anti-DDoS Pro API? Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-ddoscoo/add-auto-cc-blacklist with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud BGP-line Anti-DDoS Pro API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud BGP-line Anti-DDoS Pro itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud BGP-line Anti-DDoS Pro 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-ddoscoo. ### What is the status of the Alibaba Cloud BGP-line Anti-DDoS Pro API? Needs your own provider key (bring your own key)