# Alibaba Cloud Web Application Firewall API

> Alibaba Cloud Web Application Firewall API on Apizie: 242 endpoints (Adds addresses to an address book, Modifies the resource group of a protected object, Clears all addresses from an address book, Clears the IP blacklist for a critical event protection scenario, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Web Application Firewall (waf-openapi, version 2021-10-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds addresses to an address book
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/add-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| RuleId | integer | yes | The ID of the address book |
| AddressList | string | yes | The list of addresses to add (JSON-encoded) |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Modifies the resource group of a protected object
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The ID of the WAF resource |
| NewResourceGroupId | string | yes | The ID of the new resource group. You can view available resource groups in the Resource Management console |
| ResourceType | string | yes | The resource type. Set the value to defenseresource |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Clears all addresses from an address book
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/clear-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| RuleId | integer | yes | The ID of the address book |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Clears the IP blacklist for a critical event protection scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/clear-major-protection-black-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| TemplateId | integer | yes | The ID of the critical event protection scenario template. This parameter must be set to the ID of a protection template of the critical… |
| RuleId | integer | yes | The ID of the IP blacklist rule for critical event protection |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Copies the current mitigation template and generates a new mitigation template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/copy-defense-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| TemplateId | integer | yes | The ID of the mitigation template to copy |
| DryRun | string | no | Specifies whether to enable the dry run mode. If you do not specify this parameter, a normal request is sent. Valid values: true: A dry… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Creates an API security data export task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-api-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the current WAF instance |
| Region | string | no | The language type. Valid values: cn (default): Chinese. en: English |
| ZoneId | string | no | The time zone ID |
| Type | string | no | The type of the export task. Valid values: apisec_api (default): API asset task. apisec_abnormal: API risk task. apisec_event: API… |
| Param | string | no | The extended parameters of the export task. You can filter the exported content by specifying conditions. The value is a JSON string… |
| ClusterId | string | no | The hybrid cloud cluster ID. This parameter applies only to hybrid cloud scenarios. You can call… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Uploads an international certificate to WAF for CNAME-based access
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-certs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| CertName | string | no | The certificate name |
| CertContent | string | no | The content of the certificate file |
| CertKey | string | no | The content of the private key file that corresponds to the certificate |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Connects a cloud service to WAF in cloud native mode. Supported cloud services include ECS, CLB, NLB, and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-cloud-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call https://help.aliyun.com/document_detail/433756.html to query the ID of your WAF instance |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| Listen | string | yes | The listener configuration (JSON-encoded) |
| Redirect | string | no | The forwarding configuration (JSON-encoded) |
| Tag | string | no | The list of tags. A maximum of 20 tags can be specified (JSON-encoded) |
| RegionId | string | yes | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| OwnerUserId | string | no | The UID of the current resource ownership |

### Adds an extension certificate for cloud native mode
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-cloud-resource-extension-cert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| CloudResourceId | string | yes | The ID of the onboarded resource, which is automatically generated by WAF when the resource is added in cloud native mode. You can call… |
| CertId | string | yes | The ID of the certificate |
| RegionId | string | yes | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Creates a protected object
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-defense-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| Resource | string | no | The name of the protected object. Only protected objects in hybrid cloud service mode support custom protected object names |
| Product | string | yes | The cloud product name. Valid values: alb: Application Load Balancer (ALB). ecs: Elastic Compute Service (ECS). clb4: Classic Load… |
| ResourceGroup | string | no | The name of the protection group to which the protected object is added. This parameter is optional |
| ResourceOrigin | string | yes | The source of the protected object. Valid values: custom: user-defined |
| Pattern | string | yes | The protection mode of the protected object. Valid values: domain: domain name-based protection. multi_service: hybrid cloud service-based… |
| Detail | string | yes | The specific parameter information of the protected object, which is a string converted from a JSON object constructed with a series of… |
| XffStatus | integer | no | Specifies whether XFF proxy is enabled for the protected object. Valid values: 0: Disabled (default). 1: Enabled |
| CustomHeaders | string | no | The list of specified header fields. When XffStatus is set to 1, the first IP in the specified header field is used as the client source… |
| Description | string | no | The description of the protected object |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| OwnerUserId | string | no | The ID of the account to which the protected object belongs in multi-account scenarios. By default, the protected object belongs to the… |
| Tag | string | no | The tag list, which contains up to 20 items (JSON-encoded) |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Creates a protected object group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-defense-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call the https://help.aliyun.com/document_detail/433756.html operation to view the ID of the WAF instance |
| GroupName | string | yes | The name of the protected object group. The name must be 1 to 255 characters long and can contain Chinese characters, letters, digits,… |
| AddList | string | no | The protected objects to add to the protected object group. You can add multiple protected objects. Separate them with commas (,) |
| Description | string | no | The description of the protected object group. The description can be up to 512 characters long |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Creates a Web core protection rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-defense-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| TemplateId | integer | no | The ID of the protection template for the protection rule to be created. This parameter is required only when DefenseType is set to… |
| DefenseScene | string | yes | The WAF protection scenario to create. When the protection rule type DefenseType is set to template, valid values: waf_group: basic… |
| Rules | string | yes | The rule configuration content, which is a string converted from a JSON-formatted array of parameters. The specific parameters vary… |
| DryRun | string | no | Specifies whether to enable the dry run mode. If you do not specify this parameter, a normal request is sent. Valid values: true: A dry… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| DefenseType | string | no | The type of the protection rule |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| Resource | string | no | The protected object associated with the rule to be created. This parameter is required only when DefenseType is set to resource |

### Creates a protection template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-defense-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the current WAF instance |
| TemplateName | string | yes | The name of the protection template to create. The name must be 1 to 255 characters in length and can contain Chinese characters, letters,… |
| TemplateType | string | yes | The templatetype of the protection template to create. Valid values: user_default: default protection. user_custom: custom protection |
| TemplateStatus | integer | yes | The status of the protection template to create. Valid values: 0: Disabled. 1: Enabled |
| DefenseScene | string | yes | The protection scenario. For more information, see the DefenseScene parameter in https://help.aliyun.com/document_detail/461421.html |
| TemplateOrigin | string | yes | The source of the protection template to create. Set the value to custom, which indicates user-defined |
| DefenseSubScene | string | no | The sub-scenario of the protection template. This parameter is supported only for the advanced bot management scenario |
| Description | string | no | The description of the protection template to create |
| Detail | string | no | The detailed template information, which is a JSON-formatted string. Different key-value pairs represent different attributes of the… |
| DryRun | string | no | Specifies whether to enable the dry run mode. If you do not specify this parameter, a normal request is sent. Valid values: true: A dry… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| UnbindResources | string | no | The protected objects to unbind when creating a default protection template. Use the format ["XX1","XX2",……]. This parameter takes effect… |
| UnbindResourceGroups | string | no | The protected object groups to unbind when creating a default protection template. Use the format ["group1","group2",……]. This parameter… |

### Adds a domain name to a WAF instance for Website Config protection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| Domain | string | yes | The domain name to query |
| Listen | string | yes | The listening configuration (JSON-encoded) |
| Redirect | string | yes | The forwarding configuration (JSON-encoded) |
| RegionId | string | yes | The region where the WAF instance resides. Valid values: |
| AccessType | string | no | The access type of the WAF instance. Valid values: share (default): CNAME access. hybrid_cloud_cname: hybrid cloud CNAME access. If the… |
| Tag | string | no | The list of tags. You can specify up to 20 tags (JSON-encoded) |

### Creates a hybrid cloud Web Application Firewall (WAF) cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-hybrid-cloud-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the WAF instance |
| ClusterName | string | yes | The name of the hybrid cloud cluster |
| HttpPorts | string | yes | The listening ports for the HTTP protocol. Separate multiple ports with commas (,), such as port1,port2,port3 |
| HttpsPorts | string | yes | The listening ports for the HTTPS protocol. Separate multiple ports with commas (,), such as port1,port2,port3 |
| AccessMode | string | yes | The network access mode of the cluster. Valid values: internet: access over the Internet. vpc: access over an Express Connect circuit |
| AccessRegion | string | no | The region for Express Connect circuit access. Valid values: cn-hangzhou: Hangzhou. cn-beijing: Beijing. cn-shanghai: Shanghai |
| LogFieldsNotReturned | string | no | This parameter is deprecated. It no longer returns meaningful data |
| ProtectionServerCount | integer | yes | The maximum number of protection nodes that can be added to the hybrid cloud cluster |
| Remark | string | no | The description of the hybrid cloud cluster |
| ProxyType | string | no | The type of the hybrid cloud cluster. Valid values: cname: reverse proxy cluster. Traffic is forwarded through CNAME resolution. service:… |
| RuleStatus | string | no | Indicates whether manual bypass is enabled for the cluster. Valid values: on: Manual bypass is enabled. off: Manual bypass is disabled |
| RuleType | string | no | The type of the bypass rule. Valid values: bypass: skips WAF security checks and allows traffic to pass through directly |
| RuleConfig | string | no | The configuration of the bypass rule, in JSON format. This includes settings such as circuit breaker thresholds, request body size limits,… |
| ProxyStatus | string | no | Indicates whether the proxy gateway is enabled for the cluster. Valid values: on: The proxy gateway is enabled. off: The proxy gateway is… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Creates cluster rule information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-hybrid-cloud-cluster-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| ClusterId | integer | yes | The ID of the hybrid cloud cluster. This parameter applies only to hybrid cloud scenarios. You can call the… |
| RuleType | string | yes | The rule type. Valid values: pullin: cluster traffic redirection |
| RuleStatus | string | yes | The rule status. Valid values: on: enabled. off: disabled |
| RuleConfig | string | no | The traffic redirection rule configuration. The mode options are mutually exclusive. You can select only one. If you change the mode, all… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Creates a node group in a Hybrid Cloud Web Application Firewall (WAF) cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-hybrid-cloud-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the WAF instance |
| ClusterId | integer | yes | The ID of the Hybrid Cloud WAF cluster |
| GroupName | string | yes | The name of the node group |
| GroupType | string | yes | The type of the node group. Valid values: protect: a protection node group that processes traffic filtering. control: a control node group… |
| LoadBalanceIp | string | yes | The IP address of the load balancer that is associated with the node group |
| Remark | string | no | The remarks on the node group. You can use this parameter to add a brief description for the node group |
| LocationCode | string | no | The location code of the region where the node group resides. The value is in the format of Carrier-Continent-City |
| BackSourceMark | string | no | The back-to-origin mark of the node group. The value is in the format of Carrier-Continent-City, which is used to identify the origin of… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the resource group |

### Creates a log delivery configuration for hybrid cloud environments
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-log-delivery-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the current… |
| DeliveryName | string | yes | The name of the log delivery configuration |
| DeliveryType | string | yes | The type of the log delivery configuration. Valid values: syslog: delivers logs to a syslog service. kafka: delivers logs to a Kafka service |
| DeliveryDetail | string | yes | The content of the log delivery configuration. The value is a JSON string constructed from a series of parameters. The parameters vary… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Adds IP addresses to the IP blacklist for WAF critical event protection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-major-protection-black-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The WAF instance ID |
| TemplateId | integer | yes | The ID of the critical event protection rule template. This parameter requires the ID of a protection template of the critical event… |
| RuleId | integer | yes | The ID of the critical event protection IP blacklist rule |
| IpList | string | yes | The IP addresses to add to the IP blacklist. Custom IP addresses and CIDR blocks are supported. Both IPv4 and IPv6 are supported. Separate… |
| ExpiredTime | integer | yes | The expiration timestamp, in seconds. If the value is 0, the rule takes effect permanently |
| Description | string | no | The description of the IP blacklist |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Adds WAF member accounts in the multi-account management feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-member-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| SourceIp | string | no | The source IP address of the request. You do not need to specify this parameter. The system automatically obtains the value |
| MemberAccountIds | string | yes | The list of WAF member account IDs to manage. You can add up to 10 member accounts at a time (JSON-encoded) |

### Starts a trial for a proof of concept (POC) feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-poc-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call https://help.aliyun.com/document_detail/433756.html to query the ID of the WAF… |
| Type | string | yes | The type of the POC feature trial. Valid values: apisec: API security. botWeb: bot management for websites. botApp: bot management for… |
| RegionId | string | no | The region of the WAF instance. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Creates a Web Application Firewall (WAF) 3.0 pay-as-you-go instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-postpaid-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Uploads a China National Cryptographic Algorithm (SM) certificate for a domain that is added to WAF in CNAME…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/create-sm2-cert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| CertName | string | no | The certificate name |
| EncryptCertificate | string | no | The content of the SM encryption certificate |
| EncryptPrivateKey | string | no | The private key content of the SM encryption certificate |
| SignCertificate | string | no | The signing certificate content of the SM certificate |
| SignPrivateKey | string | no | The private key content of the SM signing certificate |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Deletes addresses from an address book
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| RuleId | integer | yes | The ID of the address book |
| AddressList | string | yes | The list of addresses to delete (JSON-encoded) |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Deletes API security risks in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-apisec-abnormals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter is applicable only to hybrid cloud scenarios. You can call… |
| AbnormalIds | string | yes | The list of API security risk IDs (JSON-encoded) |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Deletes API security events in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-apisec-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| EventIds | string | yes | The list of API security event IDs (JSON-encoded) |
| ClusterId | string | no | The hybrid cloud cluster ID. This parameter applies only to hybrid cloud scenarios. You can call… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |
| EventScope | string | no | The dimension of the security event |

### Removes a cloud service from Web Application Firewall (WAF). This operation currently supports only Elastic…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-cloud-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call https://help.aliyun.com/document_detail/433756.html to view the ID of your WAF instance |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| ResourceProduct | string | no | The type of the cloud service. Valid values: clb4: Layer 4 CLB. clb7: Layer 7 CLB. ecs: ECS. nlb: Network Load Balancer (NLB) |
| ResourceInstanceId | string | no | The ID of the cloud service instance |
| Port | integer | no | The port of the cloud service that is added to WAF |
| CloudResourceId | string | no | The ID of the protected resource. WAF automatically generates this ID when you add the cloud service to WAF. Call… |
| RegionId | string | yes | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Deletes the extended certificate for a resource onboarded in cloud native mode
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-cloud-resource-extension-cert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| CloudResourceId | string | yes | The ID of the onboarded resource. This ID is automatically generated by WAF when the resource is onboarded in cloud native mode. You can… |
| CertId | string | yes | The ID of the certificate |
| RegionId | string | yes | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Deletes a protected object
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-defense-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| Resource | string | yes | The name of the protected object |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Deletes a protected object group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-defense-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to… |
| GroupName | string | yes | The name of the protected object group that you want to delete |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region in which the WAF instance is deployed. Valid values: cn-hangzhou: The Chinese mainland. ap-southeast-1: Outside the Chinese… |

### Deletes a protection rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-defense-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| TemplateId | integer | no | The ID of the protection template to delete. This parameter is required only when DefenseType is set to template |
| RuleIds | string | yes | The IDs of the protection rules to delete. Separate multiple IDs with commas (,) |
| DefenseType | string | no | The type of the protection rule |
| DryRun | string | no | Specifies whether to enable the DryRun dry run mode. If you do not specify this parameter, a normal request is sent. Valid values: true: A… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| Resource | string | no | The protected object associated with the rule to delete. This parameter is required only when DefenseType is set to resource |

### Unblocks an IP address that is blocked by the scan protection module
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-defense-rule-block-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the… |
| TemplateId | integer | yes | The ID of the protection template |
| RuleId | integer | yes | The ID of the scan protection rule for which you want to unblock an IP address |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Deletes a protection template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-defense-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| TemplateId | integer | yes | The ID of the protection template that you want to delete |
| DryRun | string | no | Specifies whether to enable the dry run mode. If you do not specify this parameter, a normal request is sent. Valid values: true: A dry… |
| RegionId | string | no | The region in which the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Deletes a CNAME-connected domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| Domain | string | no | The domain name that has been connected to WAF. You must specify at least one of Domain and DomainId |
| RegionId | string | yes | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| AccessType | string | no | The access type of the WAF instance. Valid values: share (default): CNAME access. hybrid_cloud_cname: hybrid cloud reverse proxy access |
| DomainId | string | no | The domain name ID. You must specify at least one of Domain and DomainId |

### Deletes cluster rule information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-hybrid-cloud-cluster-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to obtain the ID of the current… |
| ClusterRuleResourceId | string | yes | The resource ID of the cluster rule |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Deletes a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-hybrid-cloud-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the WAF instance |
| ClusterId | integer | yes | The ID of the hybrid cloud cluster |
| GroupId | integer | yes | The ID of the node group |
| RegionId | string | no | The region of the WAF instance. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Deletes a hybrid cloud log forwarding delivery configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-log-delivery-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the current WAF instance |
| DeliveryName | string | yes | The name of the forwarding delivery configuration |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Deletes blacklisted IPs from a critical event protection scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-major-protection-black-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the current WAF instance |
| TemplateId | integer | yes | The ID of the critical event protection scenario template. This parameter requires the ID of a protection template of the critical event… |
| RuleId | integer | yes | The ID of the IP blacklist rule for critical event protection |
| IpList | string | yes | The IP blacklist to delete. Custom IP addresses or CIDR blocks are supported, including both IPv4 and IPv6. Separate multiple IP addresses… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Deletes a WAF member account from the multi-account management feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/delete-member-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the current… |
| SourceIp | string | no | The source IP address of the request. You do not need to specify this parameter. The system automatically obtains the value |
| MemberAccountId | string | yes | The ID of the managed WAF member account |

### Queries abnormal cloud native mode resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-abnormal-cloud-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to obtain the WAF instance ID |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries whether the current user is a delegated administrator of WAF in the multi-account management feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-account-delegated-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries addresses in an address book by paging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-addresses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| RuleId | integer | no | The ID of the address book to query |
| AddressLike | string | no | The address to query. You can set this parameter to perform a fuzzy match on added addresses |
| NextToken | string | no | The pagination token for the next page. Set this parameter to the value of NextToken returned in the previous API call. Leave this… |
| MaxResults | integer | no | The number of entries per page for paging. Valid values: 1 to 500. Default value: 20 |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries the alert banner information of a Web Application Firewall (WAF) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-alarm-banner` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the WAF instance |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the resource group to which the WAF instance belongs |

### Queries a list of alerts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-alarm-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call https://help.aliyun.com/document_detail/433756.html to query the ID of the WAF… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of API security export tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-api-exports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language type. Valid values: zh: Chinese. en: English |
| PageNumber | integer | no | The page number to return in a paging query. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page in a paging query. Default value: 10, which indicates 10 entries per page |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries statistics on API security risk domain names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-abnormal-domain-statistic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter is applicable only to hybrid cloud scenarios. You can call the… |
| StartTime | integer | no | The beginning of the time range to query. The value is a UNIX timestamp (UTC) in seconds |
| EndTime | integer | no | The end of the time range to query. The value is a UNIX timestamp (UTC) in seconds |
| PageNumber | integer | no | The page number when using paging. Sets the current page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| OrderWay | string | no | The sort order of the list. Valid values: asc: ascending order. desc: descending order |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of API security risks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-abnormals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| ApiId | string | no | The ID of the API associated with the risk |
| ApiFormat | string | no | The API operation associated with the risk |
| MatchedHost | string | no | The domain name or IP address to which the API operation belongs |
| StartTime | string | no | The start time of the query. The value is a UNIX timestamp (UTC). Unit: seconds |
| EndTime | string | no | The end time of the query. The value is a UNIX timestamp (UTC). Unit: seconds |
| OrderKey | string | no | The name of the field used for sorting. Valid values: discoverTime: the time when the risk was first detected. This is the default value.… |
| OrderWay | string | no | The sort order. Valid values: desc: descending order. This is the default value. asc: ascending order |
| AbnormalLevel | string | no | The risk level. Valid values: high: high risk. medium: medium risk. low: low risk |
| AbnormalTag | string | no | The risk type. You can call the https://help.aliyun.com/document_detail/2859155.html operation to query the supported risk types |
| AbnormalId | string | no | The risk ID |
| UserStatus | string | no | The risk status. Valid values: toBeConfirmed: to be confirmed. confirmed: confirmed. toBeFixed: to be fixed. fixed: fixed (manually… |
| PageNumber | integer | no | The page number to return in a paging query. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page in a paging query. Default value: 10, which indicates 10 entries per page |
| Origin | string | no | The source of the risk type. Valid values: custom: custom. default: built-in |
| ApiTag | string | no | The business purpose of the API. You can call the https://help.aliyun.com/document_detail/2859155.html operation to query the supported… |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter applies only to hybrid cloud scenarios. You can call the… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries the list of API security assets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-api-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the current WAF instance |
| ApiId | string | no | The ID of the API |
| ApiFormat | string | no | The API operation |
| MatchedHost | string | no | The domain name or IP address to which the API operation belongs |
| SensitiveType | string | no | The type of sensitive data in the response. You can call https://help.aliyun.com/document_detail/2859155.html to obtain the supported… |
| ApiStatus | string | no | The status of the API. Valid values: NewbornInterface: New. OfflineInterface: Inactive. normal: Normal |
| StartTime | string | no | The start time of the query, in UNIX timestamp (UTC) format. Unit: seconds |
| EndTime | string | no | The end time of the query, in UNIX timestamp (UTC) format. Unit: seconds |
| OrderKey | string | no | The name of the field used for sorting. Valid values: allCnt: total access volume in the last 30 days. botCnt: bot access volume in the… |
| OrderWay | string | no | The sort order. Valid values: desc: Descending order (default). asc: Ascending order |
| PageNumber | integer | no | The page number of the page to return in a paged query. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries to return on each page in a paged query. Default value: 10, which indicates 10 entries per page |
| Follow | integer | no | Specifies whether the API is followed. Valid values: 1: Followed. 0: Not followed |
| ApiType | string | no | The service object. Valid values: PublicAPI: Public service. ThirdpartAPI: Third-party collaboration. InternalAPI: Internal office |
| ApiTag | string | no | The business purpose of the API. You can call https://help.aliyun.com/document_detail/2859155.html to obtain the supported business purposes |
| SensitiveLevel | string | no | The sensitivity level of the API. Valid values: L1: High sensitivity. L2: Medium sensitivity. L3: Low sensitivity. N: Not sensitive |
| ApiMethod | string | no | The request method of the API. Valid values: GET: GET request. POST: POST request. HEAD: HEAD request. PUT: PUT request. DELETE: DELETE… |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter applies only to hybrid cloud scenarios. You can call… |
| Note | string | no | The remarks |
| RequestSensitiveType | string | no | The type of sensitive information in the request. You can call https://help.aliyun.com/document_detail/2859155.html to obtain the… |
| AuthFlag | string | no | Specifies whether the API has an authentication field. Valid values: 0: Has authentication. 1: Does not have authentication |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |
| ApiIds | string | no | The list of API IDs (JSON-encoded) |

### Queries the trend of API security API assets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-asset-trend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query instance ID of the current WAF… |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter is available only in hybrid cloud scenarios. You can call… |
| StartTime | integer | no | The beginning of the time range to query. The value is a UNIX timestamp (UTC). Unit: milliseconds |
| EndTime | integer | no | The end of the time range to query. The value is a UNIX timestamp (UTC). Unit: milliseconds |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the details of an API security event
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-event-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| EventId | string | yes | The ID of the API security event |
| EventScope | string | no | The dimension of the security event |
| DetailType | string | no | The type of detailed information about the security event |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter applies only to hybrid cloud scenarios. You can call the… |

### Queries the domain name statistics of API security events
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-event-domain-statistic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the current WAF instance |
| ClusterId | string | no | The hybrid cloud cluster ID. For hybrid cloud scenarios only, you can call the https://help.aliyun.com/document_detail/2849376.html… |
| StartTime | integer | no | The start time, in UNIX timestamp (UTC) format. Unit: seconds |
| EndTime | integer | no | The end time, in UNIX timestamp (UTC) format. Unit: seconds |
| PageNumber | integer | no | The page number of the page to return in a paged query. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 5, which indicates 5 entries per page |
| OrderWay | string | no | The sort order of the list. Valid values: asc: ascending order. desc: descending order |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries the list of API security events
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the current WAF instance |
| EventId | string | no | The ID of the API security event |
| ApiFormat | string | no | The API operation |
| MatchedHost | string | no | The domain name or IP address to which the API operation belongs |
| EventTag | string | no | The event type. You can call https://help.aliyun.com/document_detail/2859155.html to obtain the supported event types |
| StartTs | integer | no | The start time of the query, in UNIX timestamp (UTC) format. Unit: seconds |
| EndTs | integer | no | The end time of the query, in UNIX timestamp (UTC) format. Unit: seconds |
| OrderKey | string | no | The name of the field used for sorting. Valid values: allCnt: attack count. startTs: event start time. endTs: event end time |
| OrderWay | string | no | The sort order. Valid values: desc: Descending order (default). asc: Ascending order |
| PageNumber | integer | no | The page number to return in a paged query. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 10, which indicates 10 entries per page |
| ApiTag | string | no | The business purpose of the API. You can call https://help.aliyun.com/document_detail/2859155.html to obtain the supported business purposes |
| Origin | string | no | The source of the event type. Valid values: custom: Custom. default: Built-in |
| EventLevel | string | no | The event level. Valid values: high: High-risk. medium: Medium-risk. low: Low-risk |
| UserStatus | string | no | The event status. Valid values: toBeConfirmed: To be confirmed. confirmed: Confirmed. actioned: Handled. ignored: Ignored |
| AttackIp | string | no | The attack IP address |
| ApiId | string | no | The ID of the API |
| ClusterId | string | no | The hybrid cloud cluster ID. This parameter applies only to hybrid cloud scenarios. You can call… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |
| EventScope | string | no | The dimension of the security event |
| Account | string | no | The account information |

### Queries API security sample information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-examples` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| ApiId | string | yes | The ID of the API |
| ExampleType | string | no | The type of the sample |
| RequestSensitiveTypeList | string | no | The list of request sensitive information types (JSON-encoded) |
| ResponseSensitiveTypeList | string | no | The list of response sensitive information types (JSON-encoded) |
| AbnormalTag | string | no | The risk type |
| NextToken | string | no | The pagination token |
| MaxResults | integer | no | The number of entries per page in a paged query. Valid values: 1 to 5. Default value: 5. This parameter is used for paging |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter applies only to hybrid cloud scenarios. You can call the… |

### Queries the configurations of API security log subscription
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-log-deliveries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of domain names for API security detection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-matched-hosts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| MatchedHost | string | no | The domain name or IP address |
| PageNumber | string | no | The number of the page to return in a paged query. Default value: 1, which indicates the first page of the paging result |
| PageSize | string | no | The number of entries to return on each page in a paged query. Default value: 10, which indicates that 10 entries are returned on each… |
| Type | string | no | The detection type. Valid values: api: the list of domain names for API assets abnormal: the list of domain names with risks event: the… |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter applies only to hybrid cloud scenarios. You can call the… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Retrieves a list of active API security protection object groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-protection-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| InstanceId | string | yes | The ID of the WAF instance. Call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| ResourceGroup | string | no | The name of the protected object group |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| ApisecStatus | integer | no | The API security detection switch |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of protected objects for which API security protection is enabled
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-protection-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| Resource | string | no | The name of the protected object |
| PageNumber | integer | no | The page number to return when you perform a paged query. Default value: 1, which indicates the first page. For more information about… |
| PageSize | integer | no | The number of entries per page when you perform a paged query. Default value: 10, which indicates 10 entries per page. For more… |
| ApisecStatus | integer | no | The global switch for API security |
| RegionId | string | no | The region in which the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the configuration rules for API security policies
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the current… |
| Type | string | yes | The rule type. Valid values: risk: Risk detection. event: Security events. sensitive_word: Sensitive data. auth_flag: Authentication… |
| Level | string | no | The level of the rule. For risk detection (risk) and security events (event), valid values: high: High risk. medium: Medium risk. low: Low… |
| Name | string | no | The name of the rule |
| Origin | string | no | The source of the rule. Valid values: custom: Custom. default: Built-in |
| Status | integer | no | The enabling status of the rule. Valid values: 1: Enabled. 0: shutdown |
| PageNumber | integer | no | The page number to return in a paged query. Default value: 1, which indicates the first page of paging |
| PageSize | integer | no | The number of entries to return on each page in a paged query. Default value: 10, which indicates 10 entries per paging |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| Lang | string | no | The language of the returned rules. Valid values: zh (default): Chinese. en: English |

### Queries statistics on data endpoints associated with API security sensitive data domains
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-sensitive-domain-statistic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter applies only to hybrid cloud scenarios. You can call… |
| StartTime | integer | no | The start time. This value is a UNIX timestamp (UTC) in milliseconds |
| EndTime | integer | no | The end time. This value is a UNIX timestamp (UTC) in milliseconds |
| PageNumber | integer | no | The page number of the page to return in a paged query. Default value: 1, which indicates the first page. For more information about… |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 5, which indicates 5 entries per page. For more information about paging,… |
| Type | string | no | The type of sensitive data. Valid values: request: request sensitive data. response: response sensitive data |
| OrderWay | string | no | The sort order of the list. Valid values: asc: ascending order. desc: descending order |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of Logstores in Simple Log Service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-sls-log-stores` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the WAF instance |
| LogRegionId | string | yes | The ID of the region where logs are stored. You can call https://help.aliyun.com/document_detail/2712598.html to query the available log… |
| ProjectName | string | yes | The name of the Simple Log Service project |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of Simple Log Service projects
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-sls-projects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the current WAF instance |
| LogRegionId | string | yes | The region ID for log storage. You can call https://help.aliyun.com/document_detail/2712598.html to query the available log storage regions |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries statistics for API security risks or security events
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the… |
| Type | string | no | The type of detection statistics. Valid values: risk: statistics on security risks. event: statistics on attacks |
| ClusterId | string | no | The ID of the Hybrid Cloud WAF cluster. This parameter is available only in hybrid cloud scenarios. Call the… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| StartTime | integer | no | The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds |
| EndTime | integer | no | The end of the time range to query. This value is a UNIX timestamp. Unit: seconds |
| UserStatusList | string | no | The list of statuses used to filter the detection statistics (JSON-encoded) |

### Queries protection suggestions for API assets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-suggestions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| ApiId | string | yes | The ID of the API |
| ClusterId | string | no | The ID of the hybrid cloud cluster. This parameter applies only to hybrid cloud scenarios. You can call the… |
| RegionId | string | no | The region in which the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries user operation records for API security of Web Application Firewall (WAF)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-apisec-user-operations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the WAF instance |
| Type | string | no | The type of the operation record. Valid values: abnormal: threat detection. event: security event |
| ObjectId | string | yes | The ID of the threat detection or security event for which you want to query operation records |
| ClusterId | string | no | The ID of the Hybrid Cloud WAF cluster. This parameter is required only when WAF is deployed in hybrid cloud mode. Call the… |
| RegionId | string | no | The region in which the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group to which the WAF instance belongs |

### Queries the change records of rule group rules by paging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-base-rule-change-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| PageNumber | integer | no | The page number to return when paging. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page when paging |
| Lang | string | no | The language of the rule name. Valid values: zh: Chinese. en: English |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Queries the system rules of Web core protection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-base-system-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| PageNumber | integer | no | The page number to return in a paged query. Default value: 1, which indicates the first page. This parameter is used for paging |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 100. This parameter is used for paging |
| RuleId | integer | no | The ID of the system protection rule to query |
| RuleStatus | integer | no | The rule status. Valid values: 1: disabled. 0: enabled |
| RuleAction | string | no | The rule action. Valid values: block: Block. monitor: Monitor |
| Lang | string | no | The language of the returned rules. Valid values: zh (default): Chinese. en: English |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| DetectType | string | no | The detection module. Valid values: sqli: SQL injection. xss: cross-site scripting (XSS). cmdi: OS command injection.… |
| RiskLevel | string | no | The risk level. Valid values: super_strict: super strict. strict: strict. medium: medium. loose: loose |
| RuleName | string | no | The name of the system protection rule |
| TemplateId | integer | no | The ID of the protection template. You can set this parameter to query the system protection rules in a specific Web core protection rule… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RuleIds | string | no | The list of system protection rule IDs to query (JSON-encoded) |

### Queries the AppKey for bot management
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-bot-app-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call https://help.aliyun.com/document_detail/433756.html to query the ID of your… |
| KeyVersion | string | no | The version of the AppKey. Set the value to 1 |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Queries the bot management rule label information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-bot-rule-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| SubScene | string | no | The type of the bot management protection scenario |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| LabelType | string | no | The type of the bot rule label to query |
| NextToken | string | no | The pagination token for the next page. This parameter is returned only if a next page exists. If this parameter is returned, it indicates… |
| MaxResults | integer | no | The number of entries to return per paging in a paged query. Valid values: 1 to 200. Default value: 20 |

### Queries the details of a certificate, such as the certificate name, expiration time, issuance time, and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-cert-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| CertIdentifier | string | yes | The certificate ID |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries the certificate list of a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-certs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| Domain | string | no | The domain name |
| PageNumber | integer | no | The page number of the paged query. Default value: 1 |
| PageSize | integer | no | The number of rows per page in a paged query. Default value: 10. Maximum value: 100 |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| Algorithm | string | no | The type of encryption algorithm. Valid values: NotSM2 (default): a non-Chinese cryptographic algorithm. SM2: a Chinese cryptographic… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the pricing module information of WAF
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-charge-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |
| PayType | string | yes | The billing type of the instance. Valid values: POSTPAY: pay-as-you-go WAF instance |
| ChargeUnit | string | no | The pricing unit |

### Queries the pricing results of WAF pricing modules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-charge-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |
| PayType | string | yes | The billing type of the instance. Valid values: POSTPAY: pay-as-you-go WAF instance |
| ChargeCycle | string | no | The billing cycle for the calculation. Valid values: Year: Calculates the billing result for one year. Month: Calculates the billing… |
| ChargeModules | string | yes | The list of billing modules to calculate (JSON-encoded) |
| ChargeUnit | string | no | The metering unit |

### Queries the port details of cloud service instances that are connected to WAF
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-cloud-resource-access-port-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| ResourceInstanceId | string | yes | The instance ID of the resource |
| Port | string | no | The port of the cloud service that is connected to WAF |
| Protocol | string | no | The protocol type |
| PageNumber | integer | no | The page number of the list. Default value: 1 |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 10 |
| ResourceProduct | string | no | The cloud service type. Valid values: clb4: Layer 4 CLB. clb7: Layer 7 CLB. ecs: ECS. nlb: NLB |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Queries the ports of cloud services added to Web Application Firewall (WAF). This operation is supported…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-cloud-resource-accessed-ports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the current… |
| ResourceInstanceId | string | yes | The instance ID of the resource |
| RegionId | string | no | The region ID of the WAF instance. Valid values: cn-hangzhou: The Chinese mainland. ap-southeast-1: Outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of resources connected to WAF in cloud native mode
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-cloud-resource-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| OwnerUserId | string | no | The UID of the resource ownership user |
| ResourceInstanceId | string | no | The instance ID of the resource |
| Port | string | no | The port of the cloud service connected to WAF |
| ResourceProduct | string | no | The cloud service to which the resource belongs. Valid values: alb: Application Load Balancer (ALB). mse: Microservices Engine (MSE). fc:… |
| CloudResourceId | string | no | The ID of the connected resource, which is automatically generated by WAF in cloud native mode. You can call… |
| NextToken | string | no | The pagination token for the next page. If a value is returned for this parameter, the next page exists. If this parameter has a return… |
| MaxResults | integer | no | The number of entries per page in a paged query. Valid values: 1 to 100. Default value: 10 |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceDomain | string | no | The domain name connected to WAF. This parameter is supported only when the cloud service type is ddos |

### Queries the list of cloud services added to Web Application Firewall (WAF)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-cloud-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the WAF instance |
| ResourceInstanceId | string | no | The ID of the resource instance |
| ResourceName | string | no | The name of the resource instance |
| ResourceRegionId | string | no | The ID of the region where the resource resides. For more information, see the "Regions and supported products" section in this topic.… |
| ResourceProduct | string | no | The cloud service to which the resource belongs. By default, instances of Application Load Balancer (ALB), Microservices Engine (MSE),… |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| ResourceRouteName | string | no | The name of the route. This parameter is available when you query MSE resources |
| ResourceDomain | string | no | The domain name of the resource. This parameter is available when you query FC or SAE resources |
| ResourceFunction | string | no | The name of the function. This parameter is available when you query FC resources |
| OwnerUserId | string | no | The UID of the account to which the resource belongs |
| ResourceInstanceName | string | no | The name of the instance that is added to WAF |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the resource group |

### Queries the total number of domain names that are added to WAF, including domain names added through CNAME…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-cname-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries all log fields supported by Simple Log Service for Web Application Firewall (WAF)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-common-log-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call https://help.aliyun.com/document_detail/433756.html to query the ID of the WAF instance |
| IsRequired | string | no | Specifies whether to query for required log fields. true: Queries for required log fields. false: Queries for non-required log fields |
| IsDefault | string | no | Specifies whether to query for default log fields. true: Queries for default log fields. false: Queries for non-default log fields |
| LogKeyList | string | no | The list of log fields to query (JSON-encoded) |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Describes the compilation result of a custom regular expression rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-custom-base-rule-compile-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the WAF instance |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region of the WAF instance. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Queries whether the current WAF instance is under a DDoS attack
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-ddo-sstatus` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries the default SSL/TLS settings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-default-https` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries a paginated list of protected objects that can be associated with a defense group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-group-valid-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call https://help.aliyun.com/document_detail/433756.html to query the ID of the WAF… |
| Resource | string | no | The name of the protected object that you want to use as a filter for the query results |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 20 |
| GroupName | string | no | The name of the defense group to query. Leave this parameter empty to query for protected objects that can be associated with a new… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Query a single protected object
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html API operation to query the ID of the… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| Resource | string | yes | The name of the protected object to query. You can set this parameter to precisely query a protected object that has been added to WAF |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Retrieves the details of a protected object group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call https://help.aliyun.com/document_detail/433756.html to query the ID of the… |
| GroupName | string | yes | The name of the protected object group that you want to query |
| RegionId | string | no | The region of the WAF instance. The following fields are configured: cn-hangzhou: The Chinese mainland. ap-southeast-1: Outside the… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the names of protected object groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-resource-group-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the current… |
| GroupNameLike | string | no | The name of the protected object group that you want to query. Fuzzy query is supported |
| PageNumber | integer | no | The page number of the paginated results. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page. Default value: 20, which indicates 20 entries per page |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: regions outside the… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Retrieves information about protected object groups using pagination
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-resource-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| GroupNameLike | string | no | The name of the protected object group that you want to query. Fuzzy query is supported |
| PageNumber | integer | no | The page number. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page. Default value: 20, which indicates 20 entries per page |
| GroupNames | string | no | The names of the protected object groups that you want to query. Separate multiple names with commas (,) |
| RegionId | string | no | The region in which the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese… |

### Performs a pagination query to retrieve the names of protected objects
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-resource-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| Resource | string | no | The name of the protected object that you want to query |
| PageNumber | integer | no | The page number of the paginated results. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page. Default value: 20, which indicates 20 entries per page |
| RegionId | string | no | The region in which the WAF instance is deployed. Valid values: cn-hangzhou: The Chinese mainland. ap-southeast-1: Outside the Chinese… |

### Queries the asset owner account of a protected object in a multi-account management feature scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-resource-owner-uid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the current… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| ResourceNames | string | yes | The protected objects to query. Separate multiple protected objects with commas (,). A maximum of 100 protected objects can be queried in… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Queries the protection templates of a protected object or protected object group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-resource-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| Resource | string | yes | The name of the protected object or protected object group, or the ID of the protected asset to query |
| ResourceType | string | no | The type of the protected resource |
| RuleType | string | no | The type of the protection rule. Valid values: defense (default): protection rule. whitelist: whitelist rule |
| RuleId | integer | no | The ID of the protection rule |
| RuleName | string | no | The name of the protection rule |
| TemplateName | string | no | The name of the protection template to query |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries protected objects by paging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| PageNumber | integer | no | The page number to return when paging is used. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page when paging is used. Default value: 10, which indicates that 10 entries are returned on each page |
| Query | string | no | The query conditions. The value is a JSON string. The query results vary based on the query conditions. For more information, see Query… |
| Tag | string | no | The list of resource tags. A maximum of 20 tags can be specified (JSON-encoded) |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Queries a single protection rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| TemplateId | integer | no | The ID of the protection template to query. This parameter is required only when DefenseType is set to template |
| RuleId | integer | yes | The ID of the protection rule to query |
| DefenseType | string | no | The type of the protection rule |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| Resource | string | no | The protected object associated with the rule to query. This parameter is required only when DefenseType is set to resource |

### Queries statistics of rules under a specified WAF protection module
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-rule-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| TemplateId | integer | yes | The ID of the protection template to query. This operation supports querying protection templates under the new Bot Management… |
| PrimaryKey | string | yes | The primary query condition |
| SecondaryKey | string | no | The secondary query condition. The value cannot be the same as the primary query condition |
| ThirdKey | string | no | The tertiary query condition. The value cannot be the same as the primary or secondary query condition |
| FourthKey | string | no | The quaternary query condition. The value cannot be the same as the primary, secondary, or tertiary query condition |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries a paginated list of protection rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the… |
| RuleType | string | no | The type of the protection rule. Valid values: whitelist: a whitelist rule defense (default): a protection rule This parameter is required… |
| Query | string | no | The query conditions. Specify this parameter as a JSON string. The query results for protection rules vary based on the query conditions.… |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| DefenseType | string | no | The type of the protection rule. Valid values: template (default): template protection rules. resource: rules for protected objects.… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the protection configurations for a specific defense scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-scene-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of your WAF instance |
| RegionId | string | no | The region of the WAF instance. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the resource group |
| DefenseScene | string | yes | The defense scenario whose configuration you want to query. For more information, see the DefenseScene parameter in… |
| ConfigKey | string | yes | The name of the configuration item that you want to query. For more information, see the ConfigKey parameter in… |

### Queries a single protection template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| TemplateId | integer | yes | The ID of the protection template to query |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries the names of protected object groups that can be associated with a specific protection template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-template-valid-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the… |
| GroupName | string | no | The name of the protected object group. Use this parameter to filter results by group name |
| DefenseScene | string | yes | The protection scenario. For more information, see the valid values for the DefenseScene parameter in… |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 20 |
| TemplateId | integer | no | The ID of the protection template |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries a paginated list of protected objects that are valid for a specified protection template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-template-valid-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the… |
| DefenseScene | string | yes | The protection scenario of the protection template. For more information, see the valid values for the DefenseScene parameter in… |
| Resource | string | no | The name of the protected object that you want to query. You can specify this parameter to filter the results |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 20 |
| TemplateId | integer | no | The ID of the protection template. If you do not specify this parameter, the protected objects that can be associated with a new… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Queries a list of protection templates by paging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-defense-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| TemplateIds | string | no | The IDs of the protection templates to query. You can specify this parameter to query the protected resources associated with multiple… |
| TemplateName | string | no | The name of the protection template to query |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| TemplateId | integer | no | The ID of the protection template |
| TemplateType | string | no | The templatetype of the protection template. Valid values: user_default: default protection. user_custom: custom protection |
| DefenseScene | string | no | The protection scenario. For more information, see the DefenseScene parameter in https://help.aliyun.com/document_detail/461421.html |
| Resource | string | no | The name of the protected object, the name of the protected object group, or the ID of the protected asset. This parameter is used… |
| ResourceType | string | no | The type of the protected resource. This parameter is used together with the Resource parameter. Both parameters must have values for… |
| DefenseSubScene | string | no | The sub-scenario of the protection template. Valid values: web: bot management web protection scenario template. app: bot management app… |
| PageNumber | integer | no | The page number to return in a paging request. Default value: 1 |
| PageSize | integer | no | The number of entries per page when paging. Default value: 20 |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries whether the DNS settings of a domain name are correct
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-domain-dnsrecord` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| Domain | string | yes | The domain name to query |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Queries the details of a Website Config
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-domain-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| DomainId | string | no | The domain name ID |
| Domain | string | no | The domain name to query |
| RegionId | string | no | The region where the WAF instance resides. Valid values: |

### Queries all ports used by domain names of the current user. Only domain names with CNAME access and hybrid…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-domain-used-ports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |

### Queries the domain names that are added to Web Application Firewall (WAF)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call https://help.aliyun.com/document_detail/433756.html to view the ID of the current WAF instance |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| Domain | string | no | The domain name added to WAF |
| Backend | string | no | The IP address of the origin server or the back-to-origin domain name. You can specify only one of these options |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| DomainId | string | no | The ID of the domain name |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| Tag | string | no | The tags of the resource. A maximum of 20 tags are supported (JSON-encoded) |

### Queries the daily bills of a pay-as-you-go WAF instance for the last 7 days
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-elastic-bills` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number when using paging. Default value: 1 |
| PageSize | integer | no | The number of entries per page when using paging. Default value: 10, which indicates that each page contains 10 entries |
| InstanceId | string | yes | The WAF instance ID. You can call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the current WAF… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries traffic statistics information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-flow-chart` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| StartTimestamp | string | yes | The start time of the query. Unit: seconds |
| EndTimestamp | string | no | The end time of the query. Unit: seconds. If you do not specify this parameter, the end time is the current time |
| Interval | string | yes | The time interval. Unit: seconds. The value must be a multiple of 60 |
| Resource | string | no | The protected object to query |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the WAF… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the top 10 protected objects by request count
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-flow-top-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| StartTimestamp | string | yes | The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds |
| EndTimestamp | string | no | The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the current time… |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the resource group |

### Queries the top 10 most requested URLs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-flow-top-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| StartTimestamp | string | yes | The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds |
| EndTimestamp | string | no | The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the current time… |
| Resource | string | no | The protected object, such as a domain name or IP address added to WAF |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the resource group |

### Queries the asset statistics information for basic API security detection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-free-user-asset-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the WAF instance |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the security event statistics of API security basic detection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-free-user-event-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the security event types for basic API security detection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-free-user-event-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to obtain the ID of the WAF… |
| RegionId | string | no | The region to which the WAF instance belongs. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of security events detected by API security basic detection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-free-user-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the system status of hybrid cloud cluster nodes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-basic-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to obtain the ID of the current… |
| Mid | string | yes | The machine identifier (MID) |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Retrieves the rule information of a hybrid cloud cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-cluster-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to obtain the ID of the current WAF instance |
| ClusterId | integer | no | [Deprecated] The hybrid cloud cluster ID |
| RuleType | string | no | [Deprecated] The rule type. Valid values: pullin: cluster traffic redirection |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |
| ClusterRuleResourceId | string | no | The cluster rule resource ID |

### Cluster rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-cluster-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to obtain the ID of the WAF… |
| RuleType | string | yes | The type of the rule. Valid value: pullin: traffic redirection |
| ClusterId | integer | yes | The ID of the hybrid cloud cluster. This parameter is available only for hybrid cloud scenarios. You can call the… |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| PageNumber | integer | no | The page number. Default value: 1 |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the resource group |
| RuleContent | string | no | The prefix of the rule value to match |
| RuleMatchType | string | no | The matching logic. Valid values: exact: exact match regex: regular expression match |

### Queries the list of machines in a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-cluster-servers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| ClusterId | integer | yes | The cluster ID |
| Ip | string | no | The IP address of the server |
| HostName | string | no | The hostname |
| GroupType | string | no | The type of the hybrid cloud node group. Valid values: protect: protection. control: management. storage: storage. controlStorage:… |
| GroupName | string | no | The name of the node group |
| PageSize | integer | no | The number of entries per page for paging. Default value: 10 |
| PageNumber | integer | no | The page number. Default value: 1 |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries a list of hybrid cloud clusters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call https://help.aliyun.com/document_detail/140857.html to query the ID of the WAF instance |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of hybrid cloud node groups added to Web Application Firewall (WAF)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the ID of the current WAF… |
| ClusterId | integer | no | The ID of the hybrid cloud cluster |
| GroupName | integer | no | [Deprecated] Use GroupDisplayName for queries instead |
| GroupDisplayName | string | no | The name of the hybrid cloud node group to query |
| GroupType | string | no | The type of the hybrid cloud node group. Valid values: protect: protection. control: management. storage: storage. controlStorage:… |
| PageNumber | integer | no | The page number to return in a paging query. Default value: 1, which indicates that the first page is returned |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 10 |
| ClusterProxyType | string | no | The proxy type of the cluster. Valid values: service: SDK integration. cname: reverse proxy |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the application status of hybrid cloud cluster nodes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-process-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| Mid | string | yes | The machine identifier (MID). You can call the https://help.aliyun.com/document_detail/2982006.html operation to query the hybrid cloud… |
| RegionId | string | no | The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The Alibaba Cloud resource group ID |

### Queries the count of protectable nodes that can be added to a hybrid cloud cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-protectable-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Web Application Firewall (WAF) instance. Call the https://help.aliyun.com/document_detail/433756.html operation to query the… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the resource group |

### Queries the details of a hybrid cloud domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-resource-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the WAF instance. You can call the https://help.aliyun.com/document_detail/433756.html operation to query instance ID of… |
| Domain | string | yes | The domain name |
| Backend | string | no | The back-to-origin address |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page |
| CnameEnabled | string | no | Specifies whether to enable public cloud disaster recovery. Valid values: true: Public cloud disaster recovery is enabled. false: Public… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

### Queries the list of hybrid cloud domain names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-waf-openapi/describe-hybrid-cloud-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://wafopenapi.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the WAF instance. You can call https://help.aliyun.com/document_detail/433756.html to query the ID of the current WAF instance |
| Domain | string | no | The domain name to query |
| Backend | string | no | The IP address or domain name of the origin server that corresponds to the domain name |
| PageNumber | integer | no | The page number to return in a paging query. Default value: 1, which indicates the first page |
| PageSize | integer | no | The number of entries per page in a paging query. Default value: 10, which indicates 10 entries per page |
| CnameEnabled | string | no | Specifies whether public cloud disaster recovery is enabled. Valid values: true: Public cloud disaster recovery is enabled. false: Public… |
| RegionId | string | no | The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland |
| ResourceManagerResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |

…and 122 more. See the OpenAPI spec.

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

## FAQ

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

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

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

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