DescribeApisecSuggestions - - Alibaba Cloud Documentation Center

Queries the protection suggestions for APIs.

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:DescribeApisecSuggestions	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The region in which the Web Application Firewall (WAF) instance is deployed. Valid values: cn (default): Chinese mainland. cn-hongkong: outside the Chinese mainland.	cn
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf_v2_public_cn-pe336n43m04
ApiId	string	No	The ID of the API.	a60fd7e3021fe371c06dc1dcb883def0
ClusterId	string	No	The ID of the hybrid cloud cluster. Note For hybrid cloud scenarios only, you can call the DescribeHybridCloudClusters operation to query the hybrid cloud clusters.	428
RegionId	string	No	The region in which the WAF instance is deployed. Valid values: cn-hangzhou: Chinese mainland ap-southeast-1: outside the Chinese mainland	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Data	array<object>	The protection suggestions.
suggestion	object	The protection suggestion.
SuggestRule	string	The rule content of the protection suggestion. The value is a string that consists of multiple parameters in the JSON format. Valid values: event_tags: event type black_iplist: IP address blacklist ip_baseline: IP address freq_baseline: throttling frequency client_id_baseline: client information country_baseline: country information province_baseline: province information sensitive_type: sensitive information	{ "rule": "ClientRule", "client_id_baseline": ["Edge"] }
MatchedHost	string	The domain name or IP address of the API.	a.aliyun.com
ApiFormat	string	The API.	/apisec/v1/saveinfo
SuggestType	string	The rule type of the protection suggestion. Valid values: BotRule: bot management rules BlackIPRule: IP address blacklist rules WhiteIPRule: IP address whitelist rules RateLimitRule: throttling rules ClientRule: client rules GeoRule: region-related rules SensitiveRule: sensitive information rules UnauthRule: authentication rules	WhiteIPRule
SuggestId	string	The rule ID of the protection suggestion.	15060a1f8fed40130b7c4a7bf8d8733b

Examples

Sample success responses

JSONformat

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": [
    {
      "SuggestRule": "{\n    \"rule\": \"ClientRule\",\n    \"client_id_baseline\": [\"Edge\"]\n}",
      "MatchedHost": "a.aliyun.com",
      "ApiFormat": "/apisec/v1/saveinfo",
      "SuggestType": "WhiteIPRule",
      "SuggestId": "15060a1f8fed40130b7c4a7bf8d8733b"
    }
  ]
}

Error codes

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