GetVirusTaskInfo - 获取任务详情--云安全中心-火山引擎

文档中心

立即注册

导航

GetVirusTaskInfo - 获取任务详情

最近更新时间：2025.04.03 10:57:15首次发布时间：2025.04.03 10:57:15

task_id获取

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetVirusTaskInfo	要执行的操作，取值：GetVirusTaskInfo。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
TaskID	String	否	66eac07353890101c02b3310	任务ID

返回参数

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

参数	类型	示例值	描述
Action	String	Action	任务类型：scan_file 端上目录/文件扫描 scan_quick 快速扫描 scan_full 全盘扫描
Config	Object	--	Config
CreateTime	Integer	1702090889	创建时间
DistributedCount	Integer	21	下发总数，可能未执行完成
IDCount	Double	52.203277904400366	任务主机数
IDList	Array of String	["66eac07353890101c02b3310","66eac07353890101c02b3311"]	IDList
SubTaskCreated	Integer	82	处于已创建状态的主机数
SubTaskFailed	Integer	62	运行失败主机数
SubTaskRunning	Integer	93	运行中主机数
SubTaskSucceed	Integer	74	运行成功主机数
Tag	String	tag1	Tag
TaskID	String	66eac07353890101c02b3310	TaskID
TaskName	String	TaskName	任务名称
TaskStatus	String	TaskStatus	finished 完成 timeout 超时 failed 失败 stopped 已终止
TaskType	String	TaskType	TaskType
TaskUser	String	TaskUser	创建者
UpdateTime	Integer	1702090889	更新时间

请求示例

GET /?Action=GetVirusTaskInfo&Version=2024-05-08&TaskID=66eac07353890101c02b3310 HTTP/1.1
Host: seccenter.volcengineapi.com
X-Date: 20250219T155818Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250219/cn-beijing/seccenter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250219155818667699C0F4F09FFCAF",
        "Action": "GetVirusTaskInfo",
        "Version": "2024-05-08",
        "Service": "seccenter",
        "Region": "cn-beijing"
    },
    "Result": {
        "Action": "Action",
        "Config": {
            "CpuIDle": "",
            "FilePath": "",
            "Timeout": ""
        },
        "CreateTime": 1702090889,
        "DistributedCount": 21,
        "IDCount": 52.203277904400366,
        "IDList": [
            "66eac07353890101c02b3310",
            "66eac07353890101c02b3311"
        ],
        "SubTaskCreated": 82,
        "SubTaskFailed": 62,
        "SubTaskRunning": 93,
        "SubTaskSucceed": 74,
        "Tag": "tag1",
        "TaskID": "66eac07353890101c02b3310",
        "TaskName": "TaskName",
        "TaskStatus": "TaskStatus",
        "TaskType": "TaskType",
        "TaskUser": "TaskUser",
        "UpdateTime": 1702090889
    }
}

错误码

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

状态码	错误码	错误信息	说明
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	数据库操作异常