You need to enable JavaScript to run this app.
文档中心
云安全中心

云安全中心

复制全文
下载 pdf
HIDS_AGENT
UpdateRegularClean - 设置定期清理配置
复制全文
下载 pdf
UpdateRegularClean - 设置定期清理配置

设置 Agent 定期清理任务的启用状态、执行周期和清理范围;开关为 true 时启用、false 时关闭,周期字段单位见参数说明,成功时 Result.Data 为 ok。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

UpdateRegularClean

要执行的操作,取值:UpdateRegularClean。

Version
String
是

2024-05-08

API的版本,取值:2024-05-08。

CleanDays
Long
否

30

保留最近若干天数据,单位天;大于 99 时服务端按 99 处理,未传时为 0

CleanHours
Long
否

3

每日执行清理的小时数,按 24 小时制;未传时为 0

Switch
Boolean
否

true

true 启用定期清理,false 关闭;未传时为 false

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
Data
String

--

实际返回数据

请求示例

POST /?Action=UpdateRegularClean&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T080538Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "CleanDays": 30,
  "CleanHours": 3,
  "Switch": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "UpdateRegularClean",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": "--"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
MissingParameter

The required parameter %s is missing.

请求参数缺失,请检查参数是否已正确传入。

400
InvalidParameter

The specified parameter %s is invalid.

请求参数错误,请检查参数传递内容是否正确。

400
OperationDenied

Operation is denied because the specified resource is in use.

不允许的操作,请检查当前资源是否被占用

500
InternalError

The request has failed due to an unknown error.

服务器内部错误,请稍后重试或联系技术支持。

500
DBOperateError

The request has failed because database return error: %s

数据库操作异常,请稍后重试或联系技术支持。

最近更新时间:2026.08.21 20:30:50
这个页面对您有帮助吗?
有用
有用
无用
无用