调试

API Explorer

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

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetRegularVirusScanConfig	要执行的操作，取值：GetRegularVirusScanConfig。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
TopGroupID	String	否	group-id-001	根分组 ID，可从多级分组查询接口获取；不传时查询当前租户范围

返回参数

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

参数	类型	示例值	描述
AccountID	String	account-id-001	租户ID
Action	String	scan_quick	任务类型
AgentIDList	Array of String	["agent-id-001"]	指定主机ID
AllHost	Boolean	true	是否全部主机
CloudProviders	Array of String	["volcengine"]	云厂商
CpuIDle	String	20	扫描占用的CPU上限
FilePath	String	/var/log/example.log	扫描文件的路径
LeafGroupIDs	Array of String	["group-id-101","group-id-102"]	叶子分组 ID 列表，可通过多级分组查询接口获取；不传时不限制叶子分组
OperateUser	String	user@example.com	操作用户
ScanInterval	Long	1	0,1,2,3,4,5,6,7(分别表示：每日、每周一、每周二、每周三、……、每周日）
ScanSwitchOn	Boolean	true	开关状态
TaskEndTime	String	22:34	配置结束时间，e.g. 22:34
TaskStartTime	String	20:34	配置起始时间，e.g. 20:34
Timeout	String	48	扫描超时时间，单位：小时；不传时默认为 48 小时
TopGroupID	String	group-id-001	根分组 ID，可通过多级分组查询接口获取；不传时不限制根分组

请求示例

GET /?Action=GetRegularVirusScanConfig&Version=2024-05-08&TopGroupID=group-id-001 HTTP/1.1
Host: seccenter.volcengineapi.com
X-Date: 20241120T080538Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "GetRegularVirusScanConfig",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "AccountID": "account-id-001",
    "Action": "scan_quick",
    "AgentIDList": [
      "agent-id-001"
    ],
    "AllHost": true,
    "CloudProviders": [
      "volcengine"
    ],
    "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"
  }
}

错误码

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

状态码	错误码	错误信息	说明
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:35:54

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码