You need to enable JavaScript to run this app.
导航
DescribeScheduleSqlTask
最近更新时间:2024.04.19 13:54:15首次发布时间:2023.12.25 10:45:06

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

请求说明

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

请求参数

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

Query

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

返回参数

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

参数类型示例值描述
CreateTimeStampInteger1689042649定时 SQL 分析任务的创建时间。
DescriptionString测试定时 SQL 分析任务的简单描述。
DestProjectIDStringc4737fdd-0c72-4c1f-b35e-3ae4a02d\*\*\*\*用于存储定时 SQL 分析结果数据的目标日志主题所属日志项目。
DestRegionStringcn-shanghai目标日志项目所属地域。
DestTopicIDString66b42cb6-3436-44ae-97bf-efab3043**用于存储定时 SQL 分析结果数据的目标日志主题 ID。
DestTopicNameStringdestTopicName用于存储定时 SQL 分析结果数据的目标日志主题名称。
ModifyTimeStampInteger1689042649定时 SQL 分析任务的最近一次修改时间。
ProcessEndTimeInteger1689042649调度定时 SQL 任务的结束时间。格式为秒级时间戳。
ProcessSqlDelayInteger0每次调度的延迟时间。单位为秒。
ProcessStartTimeInteger1689042649调度定时 SQL 任务的开始时间,即第一个实例的创建时间。格式为秒级时间戳。
ProcessTimeWindowString@m-m,@mSQL 时间窗口。
QueryString*定时 SQL 分析任务定期执行的检索与分析语句。
RequestCycleObject of RequestCycle{"Type":"Period","Time":1}定时 SQL 分析任务的调度周期。
SourceProjectIDStringabd6b3a7-c730-4527-8d5f-e527b381\*\*\*源日志主题所属的日志项目 ID。
SourceProjectNameStringprojectName源日志主题所属的日志项目名称。
SourceTopicNameStringsourceTopicName进行定时 SQL 分析的原始日志所在的源日志主题名称。

Status

Integer

1

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

  • 0 :关闭任务,后续需手动启动任务。
  • 1 :立即启动。
TaskIdString2de5d435-0480-4139-9c79-b4241e88\*\*\*\*定时 SQL 分析任务 ID。
TaskNameStringtest2定时 SQL 分析任务名称。
SourceTopicIDString进行定时 SQL 分析的原始日志所在的源日志主题 ID。

RequestCycle

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

Type

String

Period

调度周期类型。可选值:

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

请求示例

GET https://tls-{Region}.ivolces.com/DescribeScheduleSqlTask?&TaskId=f3e901c3-b17f-42fd-aa8c-dc91a6c7**** HTTP/1.1
Content-Type: application/json

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
{
    "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.服务器内部错误。