ListScheduledSQLs - 列出定时SQL任务_日志服务(SLS)-阿里云帮助中心

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

log:ListScheduledSQLs

none

*全部资源

*

无

请求语法

GET /scheduledsqls HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
offset	integer	否	查询开始行，默认值为 0。	0
size	integer	否	指定查询数量，默认值为 10。	10
logstore	string	否	logstore 名称	ali-test-logstore

返回参数

名称	类型	描述	示例值
headers	object
x-log-requestid	string
Content-Type	string
Connection	string
Content-Length	string
Server	string
	object
total	integer	Project 下总的定时 SQL 任务数量	80
count	integer	当前返回的定时 SQL 任务数量	10
results	array	定时 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"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。