调用 DescribeLogBackFlowTasks 接口查询数据回流任务列表。

请求说明

请求方式：GET

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
PageNumber	Integer	否	1	分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSize	Integer	否	20	分页大小。默认为 20，最大为 100。
TopicIDList	String	否	topic1	用于筛选数据回流任务的 TopicID 列表。
TaskId	String	否	d4bd-53f1-43ff-b88a-64ee1be5****	回流任务的任务 ID。
TaskName	String	否	log-data-backflow-task-name	日志回流任务的名称。
Status	Integer	否	1	回流任务的状态，用于筛选特定状态的任务。
ScheduleSQLTaskId	String	否	ffdaa6b6-3c9f-424c-8664-fc0d222c****	定时 SQL 任务 ID。
ShipperId	String	否	4a9bd4bd-53f1-43ff-b88a-64ee1be5****	投递任务 ID。

返回参数

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

参数	类型	示例值	描述
LogBackFlowTasks	Array of LogBackFlowTaskInfo	/	数据回流任务的详情列表。
Total	Integer	10	数据回流任务的总数，表示当前查询条件下满足条件的任务数量。

LogBackFlowTaskInfo

参数	类型	示例值	描述
Status	Integer	2	数据回流任务的状态，支持的取值如下所示。 0：任务已完成； 1：任务创建中； 2：任务已结束； 3：任务删除中； 4：任务创建失败； 5：任务运行失败。
TaskId	String	d4bd-53f1-43ff-b88a-64ee1be5****	数据回流任务的任务 ID。
TaskName	String	backflow_task	数据回流任务的名称。
CreateTime	Integer	1630000000	数据回流任务的创建时间，单位为秒。
ModifyTime	Integer	1630000000	数据回流任务的最近修改时间，单位为秒。
Description	String	/	数据回流任务的描述信息。
QueryParams	Object of QueryParams	/	定时 SQL 字段配置，用于指定查询日志时的排序、筛选条件和返回字段等参数。
RelaTasksInfo	Object of RelaTasksInfo	/	回流关联任务信息。
IamProjectName	String	default	访问控制项目名称。
BackFlowEndTime	Integer	1735747200	回流任务的结束时间，单位为秒。如果设置为 nil，则表示持续回流，不设置具体结束时间。
ShipperToTosInfo	Object of ShipperToTosInfo	/	投递任务配置，用于指定日志回流任务中日志投递的相关参数。如果传空则表示不进行投递。
BackFlowStartTime	Integer	1735660800	回流任务的开始时间，单位为秒。
ScheduleSqlTaskInfo	Object of ScheduleSqlTaskInfo	/	定时 SQL 任务的相关配置信息，包括目标 topic 信息、执行周期、超时时间等。
LogBackFlowTaskSource	Object of LogBackFlowTaskSource	/	数据回流任务的数据源信息。

QueryParams

参数	类型	示例值	描述
Asc	Boolean	true	指定查询结果的排序方式是否为升序。 true：表示按升序排列； false：表示按降序排列。
Limit	Integer	100	指定查询日志时返回的日志条目数量上限。
Order	String	Start	指定查询日志时的排序字段，为空时默认按 Start字段排序。
Fields	Array of Field	/	指定查询日志时需要返回的字段列表。如果不指定，则返回所有字段。
Filters	Array of Filter	/	用于指定查询日志时的筛选条件，多个条件之间的关系默认为 AND。

RelaTasksInfo

参数	类型	示例值	描述
ShipperID	String	ffdaa6b6-3c9f-424c-8664-fc0d222c****	投递任务 ID。
DestRegion	String	cn-north-1	目标 Region 标识。
ShipperName	String	backflow_shipper_***	投递任务名称。
ScheduleSQLTaskId	String	ffdaa6b6-3c9f-424c-8664-fc0d222c****	定时 SQL 任务ID。
ScheduleSQLTaskName	String	backflow_sql_***	定时 SQL 任务名称。

ShipperToTosInfo

参数	类型	示例值	描述
ContentInfo	Object of ContentInfo	/	投递日志的内容格式配置。
TosShipperInfo	Object of TosShipperInfo	/	投递到 TOS 的相关配置信息，包括存储桶名称、前缀目录、压缩格式等。

ScheduleSqlTaskInfo

参数	类型	示例值	描述
DestRegion	String	cn-north-1	目标 topic 所在的区域，如果不填写则默认为当前 region。
MaxTimeout	Integer	300	定时 SQL 任务的最大超时时间，单位为秒。
DestTopicID	String	2a9bd4bd-53f1-43ff-b88a-64ee1be5****	定时 SQL 任务的目标日志主题 ID，用于指定 SQL 查询结果写入的目标日志主题。
RequestCycle	Object of RequestCycle	/	查询或分析请求的执行周期。
MaxRetryTimes	Integer	3	定时 SQL 任务执行失败时的最大重试次数，默认值为 3。
ProcessSqlDelay	Integer	60	定时 SQL 任务的查询延迟时间，单位为秒。
ProcessTimeWindow	String	@m-15m,@m	调度窗口表达式，用于指定定时 SQL 任务的执行时间窗口。该表达式采用特定的格式定义任务的开始和结束时间。

LogBackFlowTaskSource

参数	类型	示例值	描述
SourceType	String	Topic	日志回流任务的数据源类型，用于指定回流任务的来源类型。
LogBackFlowTaskTopicSource	Object of LogBackFlowTaskTopicSource	/	日志回流任务的数据源配置，包含日志主题 ID 和所属日志项目 ID。

Field

参数	类型	示例值	描述
Alias	String	user_name	字段别名，用于在查询结果中替换原始字段名。当查询日志时，返回的结果中将使用该别名作为字段名显示。
Column	String	user_name	指定查询日志时需要返回的字段名称，用于筛选日志中需要包含的特定字段。

Filter

参数	类型	示例值	描述
Field	String	status	用于指定查询日志时的筛选条件中的字段名称，该字段将作为过滤条件的基准字段。
Value	Object of Value	/	用于指定查询日志时的筛选条件中的比较操作符号对应的单值。
Values	Array of String	["200","404","500"]	用于指定查询日志时的筛选条件中 IN 或 NOT IN 操作符对应的多值列表。当 Operator 为 IN 或 NOT IN时，该字段为必填项。
Operator	String	=	用于指定查询日志时的筛选条件中的比较操作符。支持的取值如下所示。 >：大于； <：小于； =：等于； IN：包含在指定值列表中； NOT IN：不包含在指定值列表中； NULL：字段值为空； NOT NULL：字段值不为空。

ContentInfo

参数	类型	示例值	描述
Format	String	json	日志内容解析格式。投递到 TOS 时，支持配置为 json、jsonl、csv。投递到 Kafka 时，支持配置为 original、json。
CsvInfo	Object of CsvInfo	/	CSV 格式日志内容配置。
JsonInfo	Object of JsonInfo	/	JSON/JSONL 格式日志内容配置。

TosShipperInfo

参数	类型	示例值	描述
Bucket	String	mytos	选择 TOS 存储桶，必须与源日志主题位于同一地域。只能包含数字、横线（-）、字母a-z。开始和结尾只能是数字或字母。长度在3-63个字符之内。
Prefix	String	testprefix	存储桶的顶级目录名称。通过此投递配置投递的所有日志数据均将被投递到该目录下。不能以正斜线（/）或者反斜线（\）开头，且不能使用连续的正斜线（/）。不能以 .. 作为文件夹名称。同一存储桶中，文件夹不允许重名。
MaxSize	Integer	5	每个分区（Shard）最大可投递的原始文件大小，即未压缩的日志文件大小。单位为 MiB，取值范围为 5~256。
Compress	String	snappy	压缩格式，当前支持 snappy、gzip、lz4、none。
Interval	Integer	300	投递时间间隔，单位为秒，取值范围为 300～900。
PartitionFormat	String	%Y/%m/%d/%H/%M	投递日志的分区规则。子目录命名格式支持 strftime 语法，默认设置为 %Y/%m/%d/%H/%M，例如 2022/06/30/14/00。不能以正斜线（/）或者反斜线（\）开头。
Region	String	cn-beijing	投递对象存储桶所在区域，对外api不暴露此参数.
Endpoint	String	https://ep-xxxx.tos.cn-beijing.privatelink.volces.com	代理集群接入目标域名，对外api不暴露此参数
ProxyPoint	String	custom1	代理集群接入点，对外api不暴露此参数

RequestCycle

参数	类型	示例值	描述
Time	Integer	10	调度的周期或者定期执行的时间点（距离 00:00 的分钟数），取值范围为 1~1440，单位为分钟。
Type	String	Period	调度周期类型。可选值： Period：按照周期进行调度，即每隔一段时间调度一次。 Fixed：定期调度，即每天固定时间点调度一次。 Cron：使用 Cron 表达式。
CronTab	String	0 18 * * *	Cron表达式，日志服务通过 Cron 表达式指定告警任务定时执行。Cron 表达式的最小粒度为分钟，24 小时制。例如 0 18 * * *表示每天 18 点整执行一次告警任务。
CronTimeZone	String	GMT+0800	设置 Type 为 Cron 时，还需设置时区。常见的时区列表请参见选择时区。

LogBackFlowTaskTopicSource

参数	类型	示例值	描述
TopicID	String	0fdaa6b6-3c9f-424c-8664-fc0d222c****	日志主题 ID。
ProjectId	String	c7e0e442-19bf-4fb3-b547-5992fb8b****	日志主题所属的日志项目 ID。

CsvInfo

参数	类型	示例值	描述
Keys	Array of String	["user","log","ip"]	配置需要投递的字段。仅支持字母、数字和_-./，并且不支持以_开头。同一个索引中 Key 名称唯一。长度为 1~128。
Delimiter	String	,	分隔符，支持填入逗号、制表符、竖线、分号、空格。
EscapeChar	String	false	转义符，字段内容包含分隔符时，使用转义符包裹该字段，当前仅支持单引号，双引号，空字符。
PrintHeader	Boolean	false	首行是否打印 Key。
NonFieldContent	String	test	无效字段填充内容，长度为 0~128。

JsonInfo

参数	类型	示例值	描述
Keys	Array of String	["__content", "pod_name"]	以 JSON/JSONL 格式投递时，如果不配置此参数则表示投递所有字段，包括 __content__（必选）、__source__、__path__、__time__、__image_name__、__container_name__、__pod_name__、__pod_uid__、namespace、 __tag____client_ip__、__tag____receive_time__。
Enable	Boolean	true	启用标志。
Escape	Boolean	true	是否转义。必须配置为 true。

请求示例

返回示例

错误码

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

日志服务