You need to enable JavaScript to run this app.
导航
日志服务
  • 文档首页
    • /
  • 日志服务

CreateScheduleSqlTask

最近更新时间：2024.04.19 13:54:15

首次发布时间：2023.12.25 10:45:06

我的收藏

调用 CreateScheduleSqlTask 接口创建定时 SQL 任务。

使用说明

调用 CreateScheduleSqlTask 接口前，请确认已完成以下操作。

  • 已为当前登录账号配置跨服务访问角色与权限。详细说明请参考跨服务访问授权。
  • 已为源日志主题和目标日志主题开启索引。详细说明请参考配置索引。

请求说明

  • 请求方式：POST
  • 请求地址：https://tls-{Region}.ivolces.com/CreateScheduleSqlTask

请求参数

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

Body

参数类型是否必选示例值描述
TaskNameString是schedule-sql-task-name定时 SQL 分析任务名称。命名规则请参考资源命名规则。

TopicID

String

是

4a9bd4bd-53f1-43ff-b88a-64ee1be5****

待进行定时 SQL 分析的原始日志所在的日志主题 ID。

仅支持当前地域的日志主题。

DestRegionString否cn-north-1目标日志主题所属地域。默认为当前地域。
DestTopicIDString是2a9bd4bd-53f1-43ff-b88a-64ee1be5****用于存储定时 SQL 分析结果数据的目标日志主题ID。
ProcessStartTimeInteger是1643684482调度定时 SQL 分析任务的开始时间，即创建第一个实例的时间。格式为秒级时间戳。

ProcessEndTime

Integer

否

1643684482

调度定时 SQL 分析任务的结束时间，格式为秒级时间戳。

如果不配置，表示持续运行定时 SQL 分析任务。

说明

到达结束时间后，日志服务不会再创建实例及执行定时 SQL 分析，但任务状态仍为运行中，直至手动暂停任务。

ProcessTimeWindow

String

是

@m-15m,@m

SQL 时间窗口，即定时 SQL 分析任务运行时，日志检索与分析的时间范围，左闭右开格式。

例如，定时 SQL 分析任务的调度开始时间为2023年8月14日10:00，调度周期为每隔 1 小时执行一次，SQL 时间窗口为 [@h-1h,@h)，执行延迟 10 秒，则启动定时 SQL 分析任务后，日志服务会在 10:00:00 产生一个实例，10:00:10 开始执行实例，分析 [09:00:00~10:00:00) 期间的日志数据，并在 11:00:00 创建第二个实例，11:00:10 开始执行实例，分析 [10:00:00~11:00:00) 期间的日志数据。

说明

SQL 时间窗口最大为 24 小时，最小为 1 分钟。如果设置 SQL 时间窗口大于 24 小时，可能会因数据量过大导致执行实例运行失败或计算结果不准确。SQL 时间窗口的语法请参考SQL 时间窗口语法。

QueryString是* | select *定时 SQL 分析任务定期执行的检索与分析语句，应符合日志服务的检索与分析语法。详细语法说明请参考检索概述和分析概述。

RequestCycle

Object of RequestCycle

是

{"Type":"Period","Time":1}

定时 SQL 分析任务的调度周期。调度周期决定每个实例的调度时间。

说明

建议调度周期不小于 SQL 时间窗口，否则可能出现调度不及时，查询结果不正确。例如调度周期为每隔 10 分钟执行一次，则 SQL 时间窗口长度最大为 10 分钟。

Status

Integer

是

0

完成任务配置后是否立即启动定时 SQL 分析任务。可选值：

  • 0 ：关闭任务，后续需手动启动任务。
  • 1 ：立即启动。

ProcessSqlDelay

Integer

否

60

每次调度的延迟时间。取值范围为 0～120，单位为秒。

如果不配置，则表示 0，即无延时。

Description

String

否

This is a test schedule sql task

定时 SQL 分析任务的简单描述。

  • 不支持<>、'、\、\\。
  • 长度范围为 0～64 个字符。

RequestCycle

参数类型是否必选示例值描述
TimeInteger是10调度的周期或者定期执行的时间点（距离 00:00 的分钟数），取值范围为1~1440，单位为分钟。

Type

String

是

Period

调度周期类型。可选值：

  • Period：按照周期进行调度，即每隔一段时间调度一次。
  • Fixed：定期调度，即每天固定时间点调度一次。

返回参数

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

参数类型示例值描述
TaskIdStringd49a16d3-8711-445d-82a2-ab1689f4****定时 SQL 分析任务 ID。

请求示例

POST https://tls-{Region}.ivolces.com/CreateScheduleSqlTask HTTP/1.1
Content-Type: application/json
{
    "TaskName":"test2",
    "Description":"测试",
    "TopicID":"c5c6b3a7-c730-4527-8d5f-e527b381****",
    "DestRegion":"cn-shanghai",
    "DestTopicID":"66b42cb6-3436-44ae-97bf-efab3043****",
    "Status": 1,
    "ProcessStartTime":1689042649,
    "RequestCycle":{
        "Type":"Period",
        "Time":1
    },
    "ProcessTimeWindow":"@m-m,@m",
    "Query":"",
    "ProcessSqlDelay": 0
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
{
  "TaskId": "d150917a-d7ce-4086-88bd-7bc4e5c2****"
}

错误码

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