文档中心

日志服务

数据处理器

DescribeProcessors

DescribeProcessors

调用 DescribeProcessors 接口，根据日志项目等信息筛选查询指定的数据处理器信息。

请求说明

请求方式：GET

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
IamProjectName	String	否	team-a-project	按 IAM 项目名称过滤数据处理器列表。
ProjectId	String	否	3ab4ffc5-a5d7-43c1-9012-8466c26c****	所属的日志项目 ID。
ProjectName	String	否	my-log-project	所属的日志项目名称。
ProcessorId	String	否	9e91e9e5-2063-4182-8eff-b7371500****	按数据处理器 ID 精确匹配。
ProcessorName	String	否	log_processor_1	按数据处理器的名称模糊查询
ProcessorStatus	String	否	enabled	按数据处理器的状态查询。 enabled（默认值）：启用状态。 disabled：未启用状态。
ProcessorType	String	否	ingester	按数据处理器的类型查询。 ingester：数据写入处理器。 consumer：数据消费处理器。
OrderByProject	Boolean	否	false	是否按项目对数据处理器进行排序，默认值为 false。
PageNumber	Integer	否	1	分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSize	Integer	否	10	分页大小。默认为 10，最大为 100。

返回参数

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

参数	类型	示例值	描述
Items	Array of Response	-	返回数据处理器列表。
Total	Integer	1	表示当前查询结果的总数量。

Response

参数	类型	示例值	描述
AccountId	String	214748****	账户的唯一标识符，用于区分不同的账户。
ProjectId	String	3ab4ffc5-a5d7-43c1-9012-8466c26c****	所属的日志项目 ID。
CreateTime	String	2023-01-15T08:30:00Z	数据处理器的创建时间。
DSLContent	String	f_rename("path", "newpath")	数据处理器的 DSL 内容。用于定义处理器的具体逻辑或配置。长度范围为 1 到 4000 个字符。
UpdateTime	String	2023-01-15T10:45:00Z	数据处理器的更新时间。
Description	String	This is a data processor	数据处理器的描述信息。用于简要说明数据处理器的用途或功能。长度范围为 1 到 255 个字符。
ProcessorId	String	9e91e9e5-2063-4182-8eff-b7371500****	数据处理器 ID。
ProjectName	String	my-log-project	所属的日志项目名称。
FailStrategy	String	keep_raw	数据处理器处理失败时的策略。支持的取值如下所示。 keep_raw：保留原始数据； drop_log：丢弃日志。
ProcessorName	String	log_processor_1	数据处理器的名称。用于唯一标识一个数据处理器。长度范围为 1 到 63 个字符。
ProcessorType	String	ingester	数据处理器的类型。用于区分处理器的功能类别。 ingester：数据写入处理器。 consumer：数据消费处理器。
ProcessorStatus	String	enabled	数据处理器的状态。 enabled（默认值）：启用状态。 disabled：未启用状态。

请求示例

返回示例

错误码

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

最近更新时间：2026.05.28 17:00:46

这个页面对您有帮助吗？

有用

有用

无用

无用