You need to enable JavaScript to run this app.
导航
CreatFileScanTask - 创建病毒扫描任务
最近更新时间:2025.04.03 10:57:14首次发布时间:2025.04.03 10:57:14
我的收藏
有用
有用
无用
无用

创建病毒扫描任务

调试

请求参数

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

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

CreatFileScanTask

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

Version
String

2024-05-08

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

Action
String

Action

任务类型

AgentIDList
Array of String

["i-ycwdlfegw0qbxyxxxxxx","i-ycwdlfegw1qbxyxxxxxx"]

指定主机ID

AllHost
Boolean

true

是否全部主机

TopGroupID
String

crl9aa73pfsdrned3gmg

根分组ID

LeafGroupIDs
Array of String

["crl9aa73pfsdrned3gn0","crl9aa73pfsdrned3xv6"]

叶子分组ID列表

CloudProviders
Array of String

["volc","ali"]

云厂商

CpuIDle
String

66eac07353890101c02b3310

扫描占用的CPU上限

FilePath
String

FilePath

扫描文件的路径

TaskName
String

TaskName

任务名称

Timeout
String

Timeout

扫描超时时间

返回参数

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

参数
类型
示例值
描述
Count
Integer

78

任务数目

TaskID
String

66eac07353890101c02b3310

任务ID

请求示例

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

{
  "Action": "scan_quick",
  "AgentIDList": [
    "i-yd2yqcsc1scva4xxxxxx", "i-ycwdlfegw1qbxyxxxxxx"
  ],
  "AllHost": true,
  "TopGroupID": "crl9aa73pfsdrned3gn0",
  "LeafGroupIDs": [
    "crl9aa73pfsdrned3gmg", "crl9aa73pfsdrned3xv6"
  ],
  "CloudProviders": [
    "volc", "ali"
  ],
  "CpuIDle": "20",
  "FilePath": "/home",
  "TaskName": "scan_quick",
  "Timeout": "2000"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241204172153125137174072BA2CD2",
    "Action": "CreatFileScanTask",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Count": 100,
    "TaskID": "UzEdHwpotN"
  }
}

错误码

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

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

数据库操作异常