首页 Web应用防火墙 Web应用防火墙3.0 开发参考 API参考 API目录 API安全 DescribeApisecSuggestions - 查询API资产的防护建议

DescribeApisecSuggestions - 查询API资产的防护建议

更新时间: 2024-11-15 12:08:44

查询API资产的防护建议。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-waf:DescribeApisecSuggestionsget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

WAF 实例 ID。

说明 您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。
waf_v2_public_cn-pe336n43m04
ApiIdstring

API 的 ID。

a60fd7e3021fe371c06dc1dcb883def0
ClusterIdstring

混合云集群 ID。

说明 只针对混合云场景,您可以调用 DescribeHybridCloudClusters 获取混合云集群信息。
428
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q

返回参数

名称类型描述示例值
object

请求结果。

RequestIdstring

请求 ID。

D7861F61-5B61-46CE-A47C-6B19160D5EB0
Dataarray<object>

防护建议列表。

suggestionobject

防护建议信息。

SuggestRulestring

防护建议规则内容,以一系列参数构造的 JSON 格式转化成字符串。包括:

  • event_tags:表示事件类型。
  • black_iplist:表示 IP 黑名单列表。
  • ip_baseline:表示 IP 列表。
  • freq_baseline:表示限流频率信息。
  • client_id_baseline:表示客户端信息。
  • country_baseline:表示国家信息。
  • province_baseline:表示地区信息。
  • sensitive_type:表示敏感信息类型。
{ "rule": "ClientRule", "client_id_baseline": ["Edge"] }
MatchedHoststring

API 接口所属的域名或 IP。

a.aliyun.com
ApiFormatstring

API 接口。

/apisec/v1/saveinfo
SuggestTypestring

防护建议类型。取值:

  • BotRule:表示 Bot 规则。
  • BlackIPRule:表示 IP 黑名单规则。
  • WhiteIPRule:表示 IP 白名单规则。
  • RateLimitRule:表示限流规则。
  • ClientRule:表示客户端规则。
  • GeoRule:表示地域规则。
  • SensitiveRule:表示敏感信息规则。
  • UnauthRule:表示鉴权规则。
WhiteIPRule
SuggestIdstring

防护建议 ID。

15060a1f8fed40130b7c4a7bf8d8733b

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

上一篇: DescribeApisecUserOperations - 查询API安全用户操作记录 下一篇: DescribeApisecStatistics - 查询API安全检测统计信息
阿里云首页 Web应用防火墙 相关技术圈