调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListScanTasks	要执行的操作，取值：ListScanTasks。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
TopGroupID	String	否	group-id-001	根分组ID
FilePath	String	否	/var/log/example.log	文件路径
PageNumber	Long	是	1	翻页页码，取值范围为 1 及以上
PageSize	Long	是	20	每页记录数，取值范围为 1~1000
SortBy	String	否	LastHeartbeatTime	排序字段。本接口不支持自定义排序，结果按默认顺序返回。
SortOrder	String	否	Desc	排序顺序 Asc 升序排列 Desc 降序排列
TaskName	String	否	example-name	任务名称
TaskUser	String	否	user@example.com	任务执行用户
Action	Array of String	否	["scan_file"]	任务类型（与查询参数中的Action参数不同），枚举值：scan_quick 快速扫描、scan_full 全盘扫描、scan_file 端上目录/文件扫描；不传时查询全部三种任务类型
TaskStatus	Array of String	否	["running"]	任务状态（任务级汇总状态），枚举值：created 未执行、running 执行中、finished 已完成、failed 失败、timeout 超时；已终止任务按 failed 展示；不传时不按状态过滤

返回参数

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

参数	类型	示例值	描述
Data	Array of Object	--	分页业务数据，具体元素结构见各接口响应声明
PageNumber	Long	1	当前页面
PageSize	Long	20	页面大小
TotalCount	Long	1	全部数据条数

请求示例

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

{
  "Action": [
    "scan_file"
  ],
  "FilePath": "/var/log/example.log",
  "PageNumber": 1,
  "PageSize": 20,
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "TaskName": "example-name",
  "TaskStatus": [
    "running"
  ],
  "TaskUser": "user@example.com",
  "TopGroupID": "group-id-001"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListScanTasks",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AccountID": "account-id-001",
        "Action": "ListHidsAlarms",
        "CreateTime": 1786492800,
        "FilePath": "/var/log/example.log",
        "IDCount": 1,
        "IsInternal": true,
        "ResultNum": 1,
        "SubTaskCreated": 1,
        "SubTaskFailed": 1,
        "SubTaskRunning": 1,
        "SubTaskStopped": 1,
        "SubTaskSucceed": 1,
        "Tag": "production",
        "TaskID": "task-id-001",
        "TaskName": "example-name",
        "TaskStatus": "success",
        "TaskTimeout": 60,
        "TaskType": "default",
        "TaskUser": "user@example.com",
        "TopGroupID": "group-id-001",
        "UpdateTime": 1786579199,
        "VirusTaskID": "task-id-001"
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1
  }
}

错误码

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

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

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码