文档

BatchJobSubmit - 按资源目录批量提交产品接入任务

更新时间:

支持用户通过资源目录架构配置日志接入任务。

接口说明

入参 JsonConfig 是一个非常复杂的 JSON 配置,为此我们提供了辅助工具类帮助具体配置示例,请参考 Demo

调试

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

授权信息

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

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

请求参数

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

任务提交配置,JSON 格式。可使用 JobConfigBuilder 自动生成。

{{"autoSubmit":false,"configName":"test_builder","folderConfig":{"folderId":"rd-EUx7Qp","prodConfig":[{"allLogs":false,"allRegions":false,"logConfig":[{"logCode":"cloud_siem_rds_audit_log","logStorePattern":"vpc-test","projectPattern":"vpc-test"}],"prodCode":"rds","regions":["cn-shanghai"]},{"allLogs":true,"allRegions":true,"prodCode":"sas"}],"type":"folder"},"listenRdChange":false,"logConfigs":{"cloud_siem_rds_audit_log":{"logCode":"cloud_siem_rds_audit_log","logStorePattern":"vpc-test","projectPattern":"vpc-test"}}}}
RegionIdstring

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

cn-shanghai

返回参数

名称类型描述示例值
object

CloudSiemResponse

Dataobject

返回的具体数据。

SubmitIdstring

任务提交 ID,基于资源目录 ID,文件夹 ID,主账号 ID 生成。

BATCH_JOB_XXXXXX
ConfigListobject []

生成的接入任务配置列表。

UserIdlong

阿里云账号 ID。

123xxxxxx
ProductListobject []

产品列表。

ProductCodestring

产品 Code。

sas
LogListobject []

日志列表。

ProductCodestring

产品 Code。

sas
LogCodestring

日志 Code。

cloud_siem_cfw_flow
RegionCodestring

地域 ID。

cn-shanghai
ProjectNamePatternstring

SLS Project Name 模式。

vpc-test-project
LogStoreNamePatternstring

SLS LogStore Name 模式。

vpc-test-logstore
ErrorCodestring

任务失败原因。

ProjectLogstoreNotFound
TaskCountinteger

提交接入任务总数。

20
ConfigIdstring

配置 ID,后台自动生成。

xxxx_folder_xxxx
Successboolean

请求是否成功。取值:

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

请求状态码,返回 200 代表请求成功。

200
Messagestring

请求返回的 Message,成功为 success,失败返回具体的失败原因。

success
ErrCodestring

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

ServerError
RequestIdstring

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

5B0DFF6D-XXXX

示例

正常返回示例

JSON格式

{
  "Data": {
    "SubmitId": "BATCH_JOB_XXXXXX",
    "ConfigList": [
      {
        "UserId": 0,
        "ProductList": [
          {
            "ProductCode": "sas",
            "LogList": [
              {
                "ProductCode": "sas",
                "LogCode": "cloud_siem_cfw_flow",
                "RegionCode": "cn-shanghai",
                "ProjectNamePattern": "vpc-test-project",
                "LogStoreNamePattern": "vpc-test-logstore",
                "ErrorCode": "ProjectLogstoreNotFound"
              }
            ]
          }
        ]
      }
    ],
    "TaskCount": 20,
    "ConfigId": "xxxx_folder_xxxx"
  },
  "Success": true,
  "Code": 200,
  "Message": "success",
  "ErrCode": "ServerError",
  "RequestId": "5B0DFF6D-XXXX"
}

错误码

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

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

变更历史

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