首页 云安全中心 开发参考 API参考(威胁分析) API目录 BatchJobCheck - 检查任务接入状态(旧)

BatchJobCheck - 检查任务接入状态(旧)

更新时间: 2023-09-18 14:22:48

按提交任务生成的submitId获取接入任务的状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
SubmitIdstring

任务ID,BatchJobSubmit提交返回的submitId。

xxxxx_folder_xxxxxx
RegionIdstring

产品所在地域,默认为cn-shanghai。

cn-shanghai

返回参数

名称类型描述示例值
object

CloudSiemResponse

Dataobject

返回的详细内容。

TaskCountinteger

生成接入任务的总数。

60
FinishCountinteger

完成任务的总数。

52
FailedCountinteger

失败任务的总数。

8
TaskStatusstring

提交任务的状态。

finish
ConfigIdstring

生成的配置ID。

xxxx_folder_xxxx
FolderIdstring

资源目录文件夹ID。

fd-xxxxx
ErrTaskListobject []

失败任务的列表,枚举接入失败的阿里云账号和产品Code。

UserIdlong

阿里云账号ID。

123xxxxxx
ProductListobject []

接入失败的产品日志列表。

ProductCodestring

产品Code。

sas
LogListobject []

接入失败的日志列表。

ProductCodestring

产品Code。

sas
LogCodestring

日志Code。

cloud_siem_aegis_proc
RegionCodestring

地域ID。

cn-shanghai
ProjectNamePatternstring

待接入日志的sls project name的pattern。

vpc-project-test
LogStoreNamePatternstring

待接入日志的sls logstore name的pattern。

vpc_logstore_test
ErrorCodestring

接入失败的原因。

ProjectLogStoreNotFound
Successboolean

请求是否成功。取值:

  • true:成功
  • false:失败
true
Codeinteger

请求成功返回200。

200
Messagestring

请求成功为空,请求失败原因详细描述。

success
ErrCodestring

请求成功为空,调用出错时返回的具体错误码。

ServerError
RequestIdstring

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

5B0DFF6D-XXXX

示例

正常返回示例

JSON格式

{
  "Data": {
    "TaskCount": 60,
    "FinishCount": 52,
    "FailedCount": 8,
    "TaskStatus": "finish",
    "ConfigId": "xxxx_folder_xxxx",
    "FolderId": "fd-xxxxx",
    "ErrTaskList": [
      {
        "UserId": 0,
        "ProductList": [
          {
            "ProductCode": "sas",
            "LogList": [
              {
                "ProductCode": "sas",
                "LogCode": "cloud_siem_aegis_proc\n",
                "RegionCode": "cn-shanghai",
                "ProjectNamePattern": "vpc-project-test\n",
                "LogStoreNamePattern": "vpc_logstore_test\n",
                "ErrorCode": "ProjectLogStoreNotFound\n"
              }
            ]
          }
        ]
      }
    ]
  },
  "Success": true,
  "Code": 200,
  "Message": "success\n",
  "ErrCode": "ServerError\n",
  "RequestId": "5B0DFF6D-XXXX\n"
}

错误码

HTTP status code错误码错误信息
501CloudSiem_Internal_ExceptionCloudSiem_Internal_Exception

访问错误中心查看更多错误码。

阿里云首页 云安全中心 相关技术圈