文档

GetScheduledSQL - 获取定时SQL任务

更新时间:

获取指定的定时SQL任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /scheduledsqls/{scheduledSQLName}

请求参数

名称类型必填描述示例值
projectstring

Project 名称

ali-test-project
scheduledSQLNamestring

已存在的唯一任务名称

sql-123456789-123456

返回参数

名称类型描述示例值
headersobject
Content-Typestring

返回的响应体的内容格式

application/json
Content-Lengthstring

响应内容长度

0
Connectionstring

是否长链接。取值包括: close:不是长链接,则每个 HTTP 请求都会重新建立 TCP 连接。 keep-alive:长链接,TCP 连接建立后保持连接状态,节省连接所需时间和带宽。

close
Serverstring

服务器名称

nginx
x-log-requestidstring

服务端产生的标识,该请求的唯一 ID。

5B0A6B60BB6EE39764D458B5
ScheduledSQL

定时 SQL 任务配置

示例

正常返回示例

JSON格式

{
  "description": "This is a scheduled sql job",
  "displayName": "This is a scheduled sql job",
  "name": "test-scheduled-sql",
  "schedule": {
    "type": "FixedRate、Cron",
    "cronExpression": "0/5 * * * *",
    "runImmediately": false,
    "timeZone": "\"+0800\"",
    "delay": 4,
    "interval": "1m/1h"
  },
  "configuration": {
    "script": "",
    "sqlType": "",
    "destEndpoint": "",
    "destProject": "",
    "sourceLogstore": "",
    "destLogstore": "",
    "roleArn": "",
    "destRoleArn": "",
    "fromTimeExpr": "",
    "toTimeExpr": "",
    "maxRunTimeInSeconds": 0,
    "resourcePool": "",
    "maxRetries": 0,
    "fromTime": 0,
    "toTime": 0,
    "dataFormat": "",
    "parameters": {
      "test": "test",
      "test2": 1
    }
  },
  "createTime": 0,
  "lastModifiedTime": 0,
  "scheduleId": "",
  "status": ""
}

错误码

HTTP status code错误码错误信息描述
401AuthorizationRequiredAuthorization Required没有访问权限,需要进行用户身份认证

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈