All Products
Search
Document Center

Web Application Firewall:CreateMajorProtectionBlackIp

Last Updated:Apr 23, 2024

Creates an IP address blacklist for major event protection.

Operation description

This operation is available only on the China site (aliyun.com).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:CreateMajorProtectionBlackIpWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the Web Application Firewall (WAF) instance.

waf_v3prepaid_public_cn-2r42s6y****
TemplateIdlongYes

The ID of the IP address blacklist rule template for major event protection.

2221
RuleIdlongYes

The ID of the IP address blacklist rule for major event protection.

232324
IpListstringYes

The IP addresses that you want to add to the IP address blacklist. CIDR blocks and IP addresses are supported. IPv4 and IPv6 addresses are supported. Separate the CIDR blocks or IP addresses with commas (,). For more information, see Protection for major events.

192.0.XX.XX,192.0.XX.XX/24
ExpiredTimelongYes

The time after which the IP address blacklist becomes invalid. Unit: seconds.

Note If you set the value to 0, the blacklist is permanently valid.
1716528465
DescriptionstringNo

The description of the IP address blacklist.

Protection for major events
ResourceManagerResourceGroupIdstringNo

The ID of the resource group.

rg-acfm***q
RegionIdstringNo

The region where the WAF instance resides. Valid values:

  • cn-hangzhou: the Chinese mainland.
  • ap-southeast-1: outside the Chinese mainland.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request.

D7861F61-5B61-46CE-A47C-6B19160D****

Examples

Sample success responses

JSONformat

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D****"
}

Error codes

For a list of error codes, visit the Service error codes.