调试

API Explorer

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

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetVirusTaskInfo	要执行的操作，取值：GetVirusTaskInfo。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
TaskID	String	否	task-id-001	病毒查杀任务 ID，可从病毒任务列表获取

返回参数

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

参数	类型	示例值	描述
Action	String	ListHidsAlarms	任务类型：scan_file 端上目录/文件扫描 scan_quick 快速扫描 scan_full 全盘扫描
Config	Object	--	Config
CreateTime	Long	1786492800	创建时间
DistributedCount	Long	1	下发总数，可能未执行完成
IDCount	Double	1	任务主机数
IDList	Array of String	["id-id-001"]	IDList 标识值，可从对应资源列表接口获取
SubTaskCreated	Long	1	处于已创建状态的主机数
SubTaskFailed	Long	1	运行失败主机数
SubTaskRunning	Long	1	运行中主机数
SubTaskSucceed	Long	1	运行成功主机数
Tag	String	production	标签值
TaskID	String	task-id-001	任务唯一标识，可用于查询任务状态
TaskName	String	example-name	任务名称
TaskStatus	String	success	finished 完成 timeout 超时 failed 失败 stopped 已终止
TaskType	String	default	任务类型
TaskUser	String	user@example.com	创建者
UpdateTime	Long	1786579199	更新时间

请求示例

GET /?Action=GetVirusTaskInfo&Version=2024-05-08&TaskID=task-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": "GetVirusTaskInfo",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Action": "ListHidsAlarms",
    "Config": {
      "CpuIDle": "20",
      "FilePath": "/var/log/example.log",
      "Timeout": "48"
    },
    "CreateTime": 1786492800,
    "DistributedCount": 1,
    "IDCount": 1,
    "IDList": [
      "id-id-001"
    ],
    "SubTaskCreated": 1,
    "SubTaskFailed": 1,
    "SubTaskRunning": 1,
    "SubTaskSucceed": 1,
    "Tag": "production",
    "TaskID": "task-id-001",
    "TaskName": "example-name",
    "TaskStatus": "success",
    "TaskType": "default",
    "TaskUser": "user@example.com",
    "UpdateTime": 1786579199
  }
}

错误码

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

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

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码