调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	SetRegularVirusScanConfig	要执行的操作，取值：SetRegularVirusScanConfig。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
LeafGroupIDs	Array of String	否	["group-id-101","group-id-102"]	叶子分组 ID 列表，可通过多级分组查询接口获取；不传时不限制叶子分组
ScanInterval	Long	否	1	扫描周期；不传默认 0（每日执行）。取值：0=每日、1=每周一、2=每周二、3=每周三、4=周四、5=周五、6=周六、7=每周日
AccountID	String	否	account-id-001	租户ID
Action	String	是	scan_quick	任务类型（与查询参数Action不同），必填，枚举值：scan_quick 快速扫描、scan_full 全盘扫描、scan_file 端上目录/文件扫描
AgentIDList	Array of String	否	["agent-id-001"]	指定主机ID列表；不传时不按主机 ID 限定
FilePath	String	否	/var/log/example.log	扫描文件的路径；仅 scan_file 类型使用
AllHost	Boolean	否	true	是否全部主机；不传时按 false 处理；true 时对当前账户下已开启防护的全部主机下发任务；false 时需通过 AgentIDList、LeafGroupIDs 或 TopGroupID 指定范围，未指定任何主机范围时返回参数错误
CloudProviders	Array of String	否	["volc"]	云厂商列表，精确匹配；可选值 volc（火山引擎）、volc_edge（火山边缘云）、ali（阿里云）、tencent（腾讯云）、huawei（华为云）、aws（AWS）、ibm（IBM Cloud）、azure（Azure）、idc（云外主机）；不传时不按云厂商筛选
TaskStartTime	String	否	20:34	配置起始时间，e.g. 20:34
OperateUser	String	否	user@example.com	操作用户
ScanSwitchOn	Boolean	否	true	定时扫描开关；不传时按 false 处理（关闭定时扫描），关闭时不执行定时扫描
TaskEndTime	String	否	22:34	配置结束时间，e.g. 22:34
Timeout	String	否	48	扫描超时时间，单位：小时；范围1~168，不传时默认为 48 小时；仅 scan_quick、scan_full 生效；scan_file 类型固定 48 小时，不使用该参数
CpuIDle	String	否	20	扫描 CPU 限额，整数（1~100）；仅 scan_quick、scan_full 任务类型生效，这两种类型下必填；scan_file 类型不使用该字段
TopGroupID	String	否	group-id-001	根分组 ID，可通过多级分组查询接口获取；不传时不限制根分组

返回参数

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

参数	类型	示例值	描述
Data	String	success	返回结果

请求示例

POST /?Action=SetRegularVirusScanConfig&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

{
  "AccountID": "account-id-001",
  "Action": "scan_quick",
  "AgentIDList": [
    "agent-id-001"
  ],
  "AllHost": true,
  "CloudProviders": [
    "volc","ali"
  ],
  "CpuIDle": "20",
  "FilePath": "/var/log/example.log",
  "LeafGroupIDs": [
    "group-id-101",
    "group-id-102"
  ],
  "OperateUser": "user@example.com",
  "ScanInterval": 1,
  "ScanSwitchOn": true,
  "TaskEndTime": "22:34",
  "TaskStartTime": "20:34",
  "Timeout": "48",
  "TopGroupID": "group-id-001"
}

返回示例

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

错误码

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

状态码	错误码	错误信息	说明
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.10.30 14:09:56

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码