DescribeMajorProtectionBlackIps - Web Application Firewall

Queries IP addresses in an IP address blacklist for major event protection by page.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-waf:DescribeMajorProtectionBlackIps	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call the DescribeInstance operation to obtain the ID of the WAF instance.	waf_cdnsdf3****
TemplateId	long	No	The ID of the rule template for major event protection.	5673
RuleId	long	No	The ID of the IP address blacklist rule for major event protection.	20013199
IpLike	string	No	The IP address that you want to query. You can specify this parameter to query an IP address in the IP address blacklist for major event protection by using fuzzy matching.	192.0.XX.XX
OrderBy	string	No	The method that you want to use to sort the IP addresses in descending order. Valid values: gmtModified: sorts the IP addresses by most recent modification time. ip: sorts the IP addresses by IP address. templateId: sorts the IP addresses by template ID. id: sorts the IP addresses by primary key.	gmtModified
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q
RegionId	string	No	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

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history