ListScheduledSQLs

Updated at: 2025-03-28 03:50

Queries a list of Scheduled SQL jobs in a project.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
log:ListScheduledSQLsnone
*All Resources
*
    none
none

Request syntax

GET /scheduledsqls HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
projectstringYes

The name of the project.

ali-test-project
sizelongNo

The number of entries to return. Default value: 10.

100
logstorestringNo

The name of the Logstore.

ali-test-logstore

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
headersobject
x-log-requestidstring
5B0A6B60BB6EE39764D458B5
Content-Typestring
application/json
Connectionstring
close
Content-Lengthstring
0
Serverstring
nginx

Examples

Sample success responses

JSONformat

{
  "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": "FixedRate/Cron",
        "cronExpression": "0/5 * * * *",
        "runImmediately": false,
        "timeZone": "\"+0800\"",
        "delay": 4,
        "interval": "1m/1h"
      },
      "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"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
No change history
  • On this page (1)
  • Debugging
  • Authorization information
  • Request syntax
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare