全部产品
Search
文档中心

Web 应用防火墙:ModifyLogRetrievalStatus - 为指定域名开启或关闭日志检索功能

更新时间:Jun 27, 2024

为指定域名开启或关闭日志检索功能。

接口说明

日志检索功能已经升级为 WAF 日志服务功能,更多信息,请参见 WAF 日志服务。该接口仅适用于保有日志检索功能的存量用户。如果您需要为域名开启或关闭 WAF 日志服务,请调用 ModifyLogServiceStatus

调试

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

授权信息

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

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

请求参数

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

要操作的 WAF 实例 ID。

说明 您可以调用 DescribeInstanceInfo 查询 WAF 实例的 ID。
waf_elasticity-cn-0xldbqt****
Domainstring

已添加的域名名称。

说明 您可以调用 DescribeDomainNames 查询所有已经添加的域名。
www.example.com
Enabledinteger

是否开启日志检索功能,取值:

  • 0:表示关闭。

  • 1:表示开启。

说明 只有为域名开启日志检索功能后,WAF 才会记录该域名的访问请求日志。如果您关闭日志检索功能,则处于关闭状态期间的访问请求日志不会被记录;即使重新开启日志检索功能,您也无法查询到停用期间的访问请求日志。
1
ResourceGroupIdstring

WAF 实例在资源管理服务中所属的资源组 ID。

不设置该参数表示默认资源组。

rg-acfm2pz25js****
RegionIdstring

WAF 实例所属地域。

cn-hangzhou

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

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

示例

正常返回示例

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

错误码

HTTP status code错误码错误信息
403ForbbidenUser not authorized to operate on the specified resource.
500InternalErrorThe request processing has failed due to some unknown error.

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