文档中心

日志服务

数据加工

DescribeETLTasks

DescribeETLTasks

调用 DescribeETLTasks 接口获取加工任务列表。

请求说明

请求方式：GET

请求地址：https://{tls-endpoint}/DescribeETLTasks

请求参数

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

Query

参数	类型	是否必选	示例值	描述
ProjectId	String	否	f3e901c3-b17f-42fd-aa8c-dc91a6c7****	指定日志项目 ID，用于查询指定日志项目下的数据加工任务。
ProjectName	String	否	myproject	指定日志项目名称，用于查询指定日志项目下的数据加工任务。支持模糊查询。
IamProjectName	String	否	default	指定 IAM 项目名称，用于查询指定 IAM 项目下的数据加工任务。
SourceTopicId	String	否	f3e901c3-b17f-42fd-aa8c-dc91a6c7****	指定日志主题 ID，用于查询该日志主题相关的数据加工任务。
SourceTopicName	String	否	topic	指定日志主题名称，用于查询该日志主题相关的数据加工任务。支持模糊匹配。
TaskId	String	否	f3e901c3-b17f-42fd-aa8c-dc91a6c7****	加工任务的 ID。
TaskName	String	否	test-task	加工任务名称。
Status	String	否	WAITING	指定加工任务状态，用于查询处于该状态的数据加工任务。
PageNumber	Integer	否	10	分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSize	Integer	否	20	分页大小。默认为 20，最大为 100。

返回参数

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

参数	类型	示例值	描述
Tasks	Array of DescribeETLTaskResp	/	加工任务详细信息。
Total	Integer	5	加工任务数量。

DescribeETLTaskResp

参数	类型	示例值	描述
Name	String	etl-task-name	加工任务名称。
Enable	Boolean	true	加工任务运行状态。
Script	String	f_set("key","value")	加工规则。
TaskId	String	4a9bd4bd-53f1-43ff-b88a-64ee1be5****	加工任务 ID。
ToTime	Integer	1643684482	日志加工的结束时间，空代表无限制。
DSLType	String	NORMAL	DSL 类型，固定为 NORMAL。
FromTime	Integer	1643684482	日志加工的开始时间，空代表所有历史数据。
TaskType	String	Resident	任务类型，固定为 Resident。
ETLStatus	String	WAITING	任务调度状态。 WAITING：准备中。 RUNNING：运行中。 STOPPING：停止中。 STOPPED：已停止。 RESTARTING：重启中。
ProjectId	String	f***********	待加工日志所在的日志项目 ID。
CreateTime	String	2022-12-01 14:01:02	加工任务创建时间。
ModifyTime	String	2022-12-01 14:01:02	加工任务最近修改时间。
Description	String	This is a test project	加工任务的简单描述。
ProjectName	String	myproject	待加工数据所在的日志项目名称。
SourceTopicId	String	4a9bd4bd-53f1-43ff-b88a-64ee1be5****	待加工日志所在的日志主题 ID。
LastEnableTime	String	2022-12-01 14:01:02	最近启动时间。
SourceTopicName	String	test-topic	待加工日志所在的日志主题名称。
TargetResources	Array of TargetResourcesResp	targettopic	目标输出的日志主题。

TargetResourcesResp

参数	类型	示例值	描述
Alias	String	自定义别名	自定义输出目标的名称。
TopicId	String	4a9bd4bd-53f1-43ff-b88a-64ee1be5****	用于存储加工后日志的日志主题 ID。
ProjectId	String	4a9bd4bd-53f1-43ff-b88a-64ee1be5****	用于存储加工后日志的日志项目 ID。
TopicName	String	topicname	用于存储加工后日志的日志主题名称。
ProjectName	String	projectname	用于存储加工后日志的日志项目名称。
Region	String	cn-beijing	用于存储加工后日志的日志项目所属地域。
RoleTrn	String	trn:iam::2100000001:role/TLSETLAccessForUserA	跨账号授权角色名。可登录IAM控制台，在角色管理单击对应角色名称，查看基本信息中的角色TRN。

请求示例

返回示例

错误码

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

最近更新时间：2025.10.14 14:28:16

这个页面对您有帮助吗？

有用

有用

无用

无用