跳转到内容
搜索文档

启用日志保留

最后更新 查看 MarkdownAgent 设置

默认情况下,HTTP 请求日志不会被保留。首次使用 Logpull API 时,你需要启用保留。你也可以随时关闭保留。请注意,关闭保留后,先前保存的日志在保留期到期前仍可用(请参阅数据保留期)。

端点

有两个用于管理日志保留的端点:

  • GET /logs/control/retention/flag - 返回当前保留状态
  • POST /logs/control/retention/flag - 开启或关闭保留

使用 cURL 的示例 API 请求

检查日志保留状态

检查 zone 的日志保留标志:

Required API token permissions

At least one of the following token permissions is required:
  • Logs Write
  • Logs Read
Get log retention flagbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/logs/control/retention/flag" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
curl.exe "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag" ^
--header "Authorization: Bearer <API_TOKEN>"
$uri = "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag"
$headers = @{"Authorization" = "Bearer <API_TOKEN>"}
Invoke-RestMethod -Uri $uri -Method Get -Headers $headers

如果 zone 已启用日志保留,将返回值 true已禁用时则返回 false

开启日志保留

启用 zone 的日志保留:

Required API token permissions

At least one of the following token permissions is required:
  • Logs Write
Update log retention flagbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/logs/control/retention/flag" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"flag": true
	}'
curl.exe "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag" ^
--request POST ^
--header "Authorization: Bearer <API_TOKEN>" ^
--header "Content-Type: application/json" ^
--data "{""flag"": true}"
$uri = "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag"
$headers = @{"Authorization" = "Bearer <API_TOKEN>"}
$bodyFlag = @{flag = $true} | ConvertTo-Json
Invoke-RestMethod -Uri $uri -Method Post -Headers $headers -Body $bodyFlag -ContentType "application/json"

启用后的响应

{
	"flag": true
}

关闭日志保留

禁用 zone 的日志保留:

Required API token permissions

At least one of the following token permissions is required:
  • Logs Write
Update log retention flagbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/logs/control/retention/flag" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"flag": false
	}'
curl.exe "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag" ^
--header "Authorization: Bearer <API_TOKEN>" ^
--header "Content-Type: application/json" ^
--data "{""flag"": false}"
$uri = "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag"
$headers = @{"Authorization" = "Bearer <API_TOKEN>"}
$bodyFlag = @{flag = $false} | ConvertTo-Json
Invoke-RestMethod -Uri $uri -Method Post -Headers $headers -Body $bodyFlag -ContentType "application/json"

禁用后的响应

{
	"flag": false
}

审计

开启或关闭日志保留会记录在 Cloudflare Audit Logs 中。

这篇文档对您有帮助吗?