GetRiskDetectionTask - 获取风险检测任务状态--多云安全平台-火山引擎

文档中心

立即注册

导航

GetRiskDetectionTask - 获取风险检测任务状态

最近更新时间：2024.11.06 16:59:33首次发布时间：2024.11.06 16:59:33

获取多云风险检测任务的执行状态。

请求说明

请求方式: GET
请求地址: https://open.volcengineapi.com/?Action=GetRiskDetectionTask&Version=2023-05-01

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetRiskDetectionTask	要执行的操作，取值：GetRiskDetectionTask。
Version	String	是	2023-05-01	API的版本，取值：2023-05-01。

返回参数

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

参数	类型	示例值	描述
TaskID	String	universal_task_xxxxxxxxxxxxxx	任务记录ID
TaskType	String	by_user	（待下线，请使用TriggerType）任务类型，值：by_user（用户手动触发）、by_timer（定时触发）
TriggerType	String	by_user	触发类型，值：by_user（用户手动触发）、by_timer（定时触发）
TaskStatus	String	processing	任务状态：waiting（待调度）、processing（处理中）、succeeded（成功）、failed（失败）、timeouted（超时）
StartTimeMilli	Long	1730711440597	检测任务开始时间（毫秒）
EndTimeMilli	Long	1730712306922	检测任务结束时间（毫秒）
ProjectedStartTimeMilli	Long	1730711440597	计划开始时间（毫秒）
ProcessRate	Long	50	完成进度，0-100
ChecklistNum	Long	113	检查项数量
RiskDataStat	Object	--	本次任务执行后的风险数据，按风险等级统计的结果
ErrCode	String	an_error_code_here	任务执行失败时的错误码
ErrMsg	String	an_error_message_here	任务执行失败时的错误信息

请求示例

GET /?Action=GetRiskDetectionTask&Version=2023-05-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20241105T033223Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241105/cn-beijing/mcs/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241105113234201055008249833C12",
    "Action": "GetRiskDetectionTask",
    "Version": "2023-05-01",
    "Service": "mcs",
    "Region": "cn-beijing"
  },
  "Result": {
    "TaskID": "universal_task_xxxxxxxxxxxxxx",
    "TaskType": "by_user",
    "TriggerType": "by_user",
    "TaskStatus": "processing",
    "StartTimeMilli": 1730711440597,
    "EndTimeMilli": 1730712306922,
    "ProjectedStartTimeMilli": 1730711440597,
    "ProcessRate": 50,
    "ChecklistNum": 113,
    "RiskDataStat": {
      "Critical": 10,
      "High": 10,
      "Medium": 10,
      "Low": 10,
      "Security": 10,
      "Total": 50
    },
    "ErrCode": "an_error_code_here",
    "ErrMsg": "an_error_message_here"
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	无效参数
400	OperationDenied	Operation is denied because the specified resource is in use.	操作被拒绝
400	MissingParameter	The required parameter %s is missing.	缺失参数
500	InternalError	The request has failed due to an unknown error.	内部错误