CreateETLTask--日志服务-火山引擎

文档中心

立即注册

导航

日志服务

CreateETLTask

最近更新时间：2025.05.19 11:21:21首次发布时间：2024.09.05 16:13:38

调用 CreateETLTask 接口创建加工任务。

请求说明

请求方式：POST
请求地址：https://tls-{Region}.ivolces.com/CreateETLTask

请求参数

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

Body

参数	类型	是否必选	示例值	描述
DSLType	String	是	`NORMAL`	DSL 类型，固定为 NORMAL。
Description	String	否	`This is a test project`	数据加工任务的简单描述。不支持 `<>、'、\、\\`。长度为 0～64 个字符。
Enable	Boolean	是	`true`	是否启用数据加工任务。可选值： true：启动。 false：关闭。
FromTime	Integer	否	`1643684482`	待加工数据的开始时间。
Name	String	是	`etl-task-name`	加工任务的名称，命名规则请参考资源命名规则。
Script	String	是	`f_set("key","value")`	加工规则。
SourceTopicId	String	是	`4a9bd4bd-53f1-43ff-b88a-64ee1be5****`	待进行数据加工的日志所在的日志主题。
TargetResources	Array of TargetResources	是	`-`	输出目标的相关信息。
TaskType	String	是	`Resident`	任务类型，固定为 Resident。
ToTime	Integer	否	`1675393337`	待加工数据的结束时间。

TargetResources

参数	类型	是否必选	示例值	描述
Alias	String	是	`test`	自定义输出目标的名称，在数据加工规则中需要使用此名称指代输出目标。
TopicId	String	是	`4a9bd4bd-53f1-43ff-b88a-64ee1be5****`	用于存储加工后日志的日志主题。
RoleTrn	String	否	`trn:iam::2100000001:role/TLSETLAccessForUserA`	跨账号授权角色名。可登录IAM控制台，在角色管理单击对应角色名称，查看基本信息中的角色TRN。

返回参数

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

参数	类型	示例值	描述
TaskId	String	`063e66a3-7764-4bdc-****-709a2f4219b4`	加工任务 ID。

请求示例

POST https://tls-{Region}.ivolces.com/CreateETLTask HTTP/1.1
Content-Type: application/json
{
    "DSLType": "NORMAL",
    "Description": "This is a test project",
    "Enable": true,
    "FromTime": 1643684482,
    "Name": "etl-task-name",
    "Script": "f_set("key","value")",
    "SourceTopicId": "4a9bd4bd-53f1-43ff-b88a-64ee1be5****",
    "TargetResources": [
        {
            "Alias": "test",
            "RoleTrn": "trn:iam::2100000001:role/TLSETLAccessForUserA",
            "TopicId": "4a9bd4bd-53f1-43ff-b88a-64ee1be5****"
        }
    ],
    "TaskType": "Resident",
    "ToTime": 1675393337
}

返回示例

{"TaskId": "063e66a3-7764-4bdc-****-709a2f4219b4"}

错误码

您可访问公共错误码，获取更多错误码信息。