调用 DescribeScheduleSqlTask 接口查看指定的定时 SQL 分析任务的详情。

请求说明

请求方式：GET

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
TaskId	String	是	f3e901c3-b17f-42fd-aa8c-dc91a6c7****	定时 SQL 分析任务 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
CreateTimeStamp	Integer	1689042649	定时 SQL 分析任务的创建时间。
Description	String	This is a test schedule sql task	定时 SQL 分析任务的简单描述。
DestProjectID	String	c4737fdd-0c72-4c1f-b35e-3ae4a02d\\\\	用于存储定时 SQL 分析结果数据的目标日志主题所属日志项目。
DestRegion	String	cn-shanghai	目标日志项目所属地域。
DestTopicID	String	66b42cb6-3436-44ae-97bf-efab3043**	用于存储定时 SQL 分析结果数据的目标日志主题 ID。
DestTopicName	String	destTopicName	用于存储定时 SQL 分析结果数据的目标日志主题名称。
ModifyTimeStamp	Integer	1689042649	定时 SQL 分析任务的最近一次修改时间。
ProcessEndTime	Integer	1689042649	调度定时 SQL 任务的结束时间。格式为秒级时间戳。
ProcessSqlDelay	Integer	0	每次调度的延迟时间。单位为秒。
ProcessStartTime	Integer	1689042649	调度定时 SQL 任务的开始时间，即第一个实例的创建时间。格式为秒级时间戳。
ProcessTimeWindow	String	@m-m,@m	SQL 时间窗口。
Query	String	*	定时 SQL 分析任务定期执行的检索与分析语句。
RequestCycle	Object of RequestCycle	{"Type":"Period","Time":1}	定时 SQL 分析任务的调度周期。
SourceProjectID	String	abd6b3a7-c730-4527-8d5f-e527b381\\\*	源日志主题所属的日志项目 ID。
SourceProjectName	String	projectName	源日志主题所属的日志项目名称。
SourceTopicName	String	sourceTopicName	进行定时 SQL 分析的原始日志所在的源日志主题名称。
Status	Integer	1	完成任务配置后是否立即启动定时 SQL 分析任务。 0 ：关闭任务，后续需手动启动任务。 1 ：立即启动。
TaskId	String	2de5d435-0480-4139-9c79-b4241e88\\\\	定时 SQL 分析任务 ID。
TaskName	String	test2	定时 SQL 分析任务名称。
SourceTopicID	String	66b42cb6-3436-44ae-97bf-efab3043\\	进行定时 SQL 分析的原始日志所在的源日志主题 ID。

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 时，还需设置时区。常见的时区列表请参见选择时区。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	参数不合法。
404	ScheduleSqlTaskNotExist	Task %s does not exist.	定时 SQL 分析任务不存在。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。

日志服务