全部产品
Search
文档中心

日志服务:ListScheduledSQLs - 列出定时SQL任务

更新时间:Dec 12, 2024

列出指定Project下的定时SQL任务。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
log:ListScheduledSQLsnone
*全部资源
*

请求语法

GET /scheduledsqls HTTP/1.1

请求参数

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

Project 名称

ali-test-project
offsetlong

查询开始行,默认值为 0。

0
sizelong

指定查询数量,默认值为 10。

10
logstorestring

logstore 名称

ali-test-logstore

返回参数

名称类型描述示例值
headersobject
x-log-requestidstring

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

5B0A6B60BB6EE39764D458B5
Content-Typestring

返回的响应体的内容格式。

application/json
Connectionstring

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

close
Content-Lengthstring

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

0
Serverstring

服务器名称。

nginx
object
totalinteger

Project 下总的定时 SQL 任务数量

80
countinteger

当前返回的定时 SQL 任务数量

10
resultsarray

定时 SQL 任务列表

ScheduledSQL

定时 SQL 任务配置

示例

正常返回示例

JSON格式

{
  "total": 80,
  "count": 10,
  "results": [
    {
      "description": "This is a scheduled sql job",
      "displayName": "This is a scheduled sql job",
      "name": "test-scheduled-sql",
      "schedule": {
        "type": "Cron",
        "cronExpression": "0/5 * * * *",
        "runImmediately": false,
        "timeZone": "+0800",
        "delay": 4,
        "interval": "1m"
      },
      "configuration": {
        "script": "* | select *",
        "sqlType": "searchQuery",
        "destEndpoint": "cn-hangzhou-intranet.log.aliyuncs.com",
        "destProject": "project-demo",
        "sourceLogstore": "source-logstore-demo",
        "destLogstore": "dest-logstore-demo",
        "roleArn": "acs:ram::123456789:role/aliyunlogetlrole",
        "destRoleArn": "acs:ram::123456789:role/aliyunlogetlrole",
        "fromTimeExpr": "@m-1m",
        "toTimeExpr": "@m",
        "maxRunTimeInSeconds": 600,
        "resourcePool": "enhanced",
        "maxRetries": 20,
        "fromTime": 1712592000,
        "toTime": 0,
        "dataFormat": "log2log",
        "parameters": {
          "test": "test",
          "test2": 1
        }
      },
      "createTime": 1714123644,
      "lastModifiedTime": 1714123644,
      "scheduleId": "e73f43732852064ad5d091914e39342f",
      "status": "ENABLED"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史