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

文档中心

立即注册

导航

DescribeETLTask

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

调用 DescribeETLTask 获取指定加工任务的详细信息。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
TaskId	String	是	`f3e901c3-b17f-42fd-aa8c-dc91a6c7****`	待查询的加工任务 ID。

返回参数

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

参数	类型	示例值	描述
CreateTime	String	`2022-12-01 14:01:02`	加工任务的创建时间。
DSLType	String	`NORMAL`	DSL 类型，固定为 NORMAL。
DashboardId	String	`/`	内置的加工仪表盘 ID。
Description	String	`This is a test project`	数据加工任务的简单描述。不支持 `<>、'、\、\\`。长度为 0～64 个字符。
ETLStatus	String	`WAITING`	任务调度状态。 WAITING：准备中。 RUNNING：运行中。 STOPPING：停止中。 STOPPED：已停止。 RESTARTING：重启中
Enable	Boolean	`true`	是否启用数据任务。 ture：启动。 false：关闭。
FromTime	Integer	`1643684482`	待加工数据的开始时间，空代表加工所有历史数据。
LastEnableTime	String	`2022-12-01 14:01:02`	最近启动时间。
ModifyTime	String	`2022-12-01 14:01:02`	加工任务的创建时间。
Name	String	`etl-task-name`	加工任务名称。
ProjectId	String	`f***********`	待加工数据所在的日志项目 ID。
ProjectName	String	`myproject`	待加工数据所在的日志项目名称。
Script	String	`f_set("key","value")`	加工规则。
SourceTopicId	String	`4a9bd4bd-53f1-43ff-b88a-64ee1be5****`	待加工数据所在的日志主题 ID。
SourceTopicName	String	`test-topic`	待加工数据所在的日志主题名称。
TargetResources	Array of TargetResourcesResp	`/`	输出目标的相关信息。
TaskId	String	`4a9bd4bd-53f1-43ff-b88a-64ee1be5****`	加工任务 ID。
TaskType	String	`Resident`	任务类型，固定为 Resident。
ToTime	Integer	`1643684482`	日志加工数据范围的结束时间，空代表无限制。

TargetResourcesResp

参数	类型	示例值	描述
Alias	String	`test`	自定义输出目标的名称。
TopicId	String	`4a9bd4bd-53f1-43ff-b88a-64ee1be5****`	用于存储加工后日志的日志主题 ID。
ProjectId	String	`4a9bd4bd-53f1-43ff-b88a-64ee1be5****`	用于存储加工后日志的日志项目 ID。
TopicName	String	`mytopic`	用于存储加工后日志的日志主题名称。
ProjectName	String	`myproject`	用于存储加工后日志的日志项目名称。

请求示例

GET https://tls-{Region}.ivolces.com/DescribeETLTask?&TaskId=f3e901c3-b17f-42fd-aa8c-dc91a6c7**** HTTP/1.1
Content-Type: application/json

返回示例

{
            "TaskId": "e9b00e4a-ae***c4-83e5-a38d7f73ebfc",
            "Name": "zy-access-",
            "SourceTopicId": "5687efb0-4a*****5-4447770a3fe6",
            "SourceTopicName": "access-log",
            "DSLType": "NORMAL",
            "Script": "e_keep(f_has(\"__time__\"))",
            "TaskType": "Resident",
            "TargetResources": [
                {
                    "TopicId": "e2cc153d-3ba8-4****80e1ef1bead9",
                    "TopicName": "topic1",
                    "ProjectId": "4012777e-c******dc4b3a4ab",
                    "ProjectName": "zy-test",
                    "Alias": "target"
                }
            ],
            "Enable": true,
            "Description": "勿删，勿暂停",
            "ETLStatus": "RUNNING",
            "FromTime": 1709025132,
            "CreateTime": "2024-02-27 17:12:30",
            "ModifyTime": "2024-02-27 17:12:49",
            "LastEnableTime": "2024-02-27 17:12:30",
            "DashboardId": "",
            "ProjectId": "d11be542-****170-72c318262132",
            "ProjectName": "log-sy"
        }

错误码

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