文档

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

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:BatchJobCheckRead
  • acs:yundun-sas::{#accountId}:*

请求参数

名称类型必填描述示例值
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

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

变更历史

变更时间变更内容概要操作
2024-03-27OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:501
  • 本页导读 (1)