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

DescribeScheduleSqlTasks

最近更新时间：2024.04.19 15:03:22

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

我的收藏

调用 DescribeScheduleSqlTasks 接口查看指定地域下所有定时 SQL 分析任务的详情。支持分页查询。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ProjectIdString否f3e901c3-b17f-42fd-aa8c-dc91a6c7****源日志主题所属的日志项目 ID。
ProjectNameString否yyj-test源日志主题所属的日志项目名称。
IamProjectNameString否test IAM 日志项目名称。
TopicIdString否f3e901c3-b17f-42fd-aa8c-dc91a6c7****源日志主题 ID。
SourceTopicNameString否topic名称源日志主题名称。
TaskIdString否f3e901c3-b17f-42fd-aa8c-dc91a6c7****定时 SQL 分析任务 ID。
TaskNameString否test-task定时 SQL 分析任务名称。
StatusString否0定时SQL任务的状态
PageNumberInteger否10分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSizeInteger否20分页大小。默认为 20，最大为 100。

返回参数

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

参数类型示例值描述
TasksArray of DescribeScheduleSqlTaskResp[{"TaskId":"2de5d435-0480-4139-9c79-b4241e88****","TaskName":"test2","Description":"测试","SourceProjectID":"abd6b3a7-c730-4527-8d5f-e527b381****","SourceProjectName":"projectName","SourceTopicID":"c5c6b3a7-c730-4527-8d5f-e527b381****","SourceTopicName":"sourceTopicName","DestRegion":"cn-shanghai","DestProjectID":"c4737fdd-0c72-4c1f-b35e-3ae4a02d****","DestTopicID":"66b42cb6-3436-44ae-97bf-efab3043****","DestTopicName":"destTopicName","Status":1,"ProcessStartTime":1689042649,"RequestCycle":{"Type":"Period","Time":1},"ProcessTimeWindow":"@m-m,@m","CreateTimeStamp":1689042649,"ModifyTimeStamp":1689042649,"Query":"","ProcessSqlDelay":0}]定时 SQL 分析任务列表。
TotalInteger1返回的总任务数。

DescribeScheduleSqlTaskResp

参数类型示例值描述
QueryString* | select count(*)定时 SQL 分析任务定期执行的检索分析语句。

Status

Integer

0

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

  • 0 ：关闭任务，后续需手动启动任务。
  • 1 ：立即启动。
TaskIdString2de5d435-0480-4139-9c79-b4241e88****定时 SQL 分析任务 ID。
TaskNameStringtask-name定时 SQL 分析任务名称。
DestRegionStringcn-shanghai目标日志项目所属地域。
DescriptionStringThis is a test ins.定时 SQL 分析任务的简单描述。
DestTopicIDStringd49a16d3-8711-445d-82a2-ab1689f4****用于存储定时 SQL 分析结果数据的目标日志主题ID。

RequestCycle

Object of RequestCycle

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

定时 SQL 分析任务的调度周期。

  • Type：调度周期类型。
    • Period：按照周期进行调度，即每隔一段时间调度一次。
    • Fixed：定期调度，即每天固定时间点调度一次。
  • Time：调度的周期或者定期执行的时间点（距离 00:00 的分钟数），取值范围为 1~1440，单位为分钟。
DestProjectIDStringc253c122-aa35-42bd-9a9e-30f47c95****目标日志主题所属的日志项目 ID。
DestTopicNameStringdest-topic-name用于存储定时 SQL 分析结果数据的目标日志主题名称。
ProcessEndTimeInteger1702118732调度定时 SQL 分析任务的结束时间。格式为秒级时间戳。
CreateTimeStampInteger1702032332定时 SQL 分析任务的创建时间。
ModifyTimeStampInteger1702032332定时 SQL 分析任务的最近一次修改时间。
ProcessSqlDelayInteger0每次调度的延迟时间，单位为秒。
SourceProjectIDStringd49a16d3-8711-445d-82a2-ab1689f4****源日志主题所属的日志项目 ID。
SourceTopicNameStringtopicName进行定时 SQL 分析的原始日志所在的源日志主题名称。
ProcessStartTimeInteger1702032332调度定时 SQL 任务的开始时间, 即第一个实例被调度的开始时间。格式为秒级时间戳。
ProcessTimeWindowString@m-m,@mSQL 时间窗口。
SourceProjectNameStringd49a16d3-8711-445d-82a2-ab1689f4****源日志主题所属的日志项目名称。
SourceTopicIDString进行定时 SQL 分析的原始日志所在的源日志主题 ID。

RequestCycle

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

Type

String

Period

调度周期类型。可选值：

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

请求示例

GET https://tls-{Region}.ivolces.com/DescribeScheduleSqlTasks?&ProjectId=f3e901c3-b17f-42fd-aa8c-dc91a6c7****&ProjectName=&TopicId=f3e901c3-b17f-42fd-aa8c-dc91a6c7****&SourceTopicName=topic名称&TaskId=f3e901c3-b17f-42fd-aa8c-dc91a6c7****&TaskName=test-task&PageNumber=10&PageSize=20 HTTP/1.1
Content-Type: application/json

返回示例

{
    "Total":1,
    "Tasks":[
        {
            "TaskId":"2de5d435-0480-4139-9c79-b4241e88****",
            "TaskName":"test2",
            "Description":"测试",
            "SourceProjectID":"abd6b3a7-c730-4527-8d5f-e527b381****",
            "SourceProjectName":"projectName",
            "SourceTopicID":"c5c6b3a7-c730-4527-8d5f-e527b381****",
            "SourceTopicName":"sourceTopicName",
            "DestRegion":"cn-shanghai",
            "DestProjectID":"c4737fdd-0c72-4c1f-b35e-3ae4a02d****",
            "DestTopicID":"66b42cb6-3436-44ae-97bf-efab3043****",
            "DestTopicName":"destTopicName",
            "Status":1,
            "ProcessStartTime":1689042649,
            "RequestCycle":{
                "Type":"Period",
                "Time":1
            },
            "ProcessTimeWindow":"@m-m,@m",
            "CreateTimeStamp":1689042649,
            "ModifyTimeStamp":1689042649,
            "Query":"",
            "ProcessSqlDelay":0
        }
    ]
}

错误码

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

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