DescribeMajorProtectionBlackIps - Web Application Firewall

Queries the IP address blacklist for major event protection in a paginated format.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:DescribeMajorProtectionBlackIps

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to obtain the ID of the current WAF instance.	waf_cdnsdf3****
TemplateId	integer	No	The ID of the major event protection template.	5673
RuleId	integer	No	The ID of the IP address blacklist rule for major event protection.	20013199
IpLike	string	No	The IP address to query. You can set this parameter to perform a fuzzy query on the added IP address blacklist.	192.0.XX.XX
OrderBy	string	No	The property by which to sort the results in descending order. Valid values: gmtModified: sorts by modification time. ip: sorts by IP address. templateId: sorts by template ID. id: sorts by primary key.	gmtModified
PageNumber	integer	No	The page number. Default value: 1, which indicates the first page.	1
PageSize	integer	No	The number of entries per page. Default value: 10, which indicates 10 entries per page.	10
RegionId	string	No	The region in which the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: regions outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The result of the request.
TotalCount	integer	The total number of IP addresses in the blacklist.	63
RequestId	string	The ID of the request.	41631674-EEB0-5B02-BEB4-40A758E9B841
IpList	array<object>	The list of IP addresses in the blacklist.
	object	The list of IP addresses in the blacklist.
Description	string	The description of the template.	test0003asdffas
Ip	string	The IP address.	192.0.XX.XX
RuleId	integer	The ID of the IP address blacklist rule for major event protection.	8508970
ExpiredTime	integer	The timestamp after which the IP address blacklist becomes invalid. Unit: seconds. Note If the value is 0, the IP address blacklist is permanently valid.	1662603328
GmtModified	integer	The time when the IP address in the blacklist was modified.	1665456202000
TemplateId	integer	The ID of the major event protection template.	9684

Examples

Success response

JSON format

{
  "TotalCount": 63,
  "RequestId": "41631674-EEB0-5B02-BEB4-40A758E9B841",
  "IpList": [
    {
      "Description": "test0003asdffas",
      "Ip": "192.0.XX.XX",
      "RuleId": 8508970,
      "ExpiredTime": 1662603328,
      "GmtModified": 1665456202000,
      "TemplateId": 9684
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.