All Products
Search

This Product

    Web Application Firewall:DescribeApisecSuggestions

    Document Center

    Web Application Firewall:DescribeApisecSuggestions

    Last Updated:Jul 06, 2026

    Queries protection suggestions for API assets.

    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:DescribeApisecSuggestions

    get

    *All Resource

    *
    • acs:ResourceGroupId
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    Instance ID of the WAF instance.

    Note

    You can call the DescribeInstance operation to query instance ID of the WAF instance.

    waf_v2_public_cn-pe336n43m04
    ApiId

    string

    Yes

    The ID of the API.

    a60fd7e3021fe371c06dc1dcb883def0
    ClusterId

    string

    No

    The ID of the hybrid cloud cluster.

    Note

    This parameter applies only to hybrid cloud scenarios. You can call the DescribeHybridCloudClusters operation to obtain hybrid cloud cluster information.

    428
    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 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 response.

    RequestId

    string

    The request ID.

    D7861F61-5B61-46CE-A47C-6B19160D5EB0
    Data

    array<object>

    The list of protection suggestions.

    object

    The protection suggestion information.

    SuggestRule

    string

    The content of the protection suggestion rule, which is a string converted from a JSON object constructed with a series of parameters. The parameters include:

    • event_tags: the event type.

    • black_iplist: the IP blacklist.

    • ip_baseline: the IP list.

    • freq_baseline: the throttling frequency information.

    • client_id_baseline: the client information.

    • country_baseline: the country information.

    • province_baseline: the region information.

    • sensitive_type: the sensitive information type.

    { "rule": "ClientRule", "client_id_baseline": ["Edge"] }
    MatchedHost

    string

    The domain name or IP address to which the API operation belongs.

    a.aliyun.com
    ApiFormat

    string

    The API operation.

    /apisec/v1/saveinfo
    SuggestType

    string

    The type of the protection suggestion. Valid values:

    • BotRule: bot rule.

    • BlackIPRule: IP blacklist rule.

    • WhiteIPRule: IP whitelist rule.

    • RateLimitRule: throttling rule.

    • ClientRule: client rule.

    • GeoRule: geo-blocking rule.

    • SensitiveRule: sensitive information rule.

    • UnauthRule: authentication rule.

    WhiteIPRule
    SuggestId

    string

    The ID of the protection suggestion.

    15060a1f8fed40130b7c4a7bf8d8733b

    Examples

    Success response

    JSON format

    {
  "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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.