GetScheduledSQL

0.0.201

Queries the information about a Scheduled SQL job.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation

Operation	Access level	Resource type	Condition key	Associated operation
log:GetScheduledSQL	get	All Resources ``	none	none

Request syntax

            
GET /scheduledsqls/{scheduledSQLName} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
scheduledSQLName	string	Yes	The unique name of the job. Make sure that the job exists.	sql-123456789-123456

Response parameters

Parameter	Type	Description	Example

Parameter	Type	Description	Example
headers	object
Content-Type	string		application/json
Content-Length	string	The content length of the response body.	0
Connection	string		close
Server	string		nginx
x-log-requestid	string		5B0A6B60BB6EE39764D458B5
	ScheduledSQL

Examples

Sample success responses

JSONformat

            
            
          
{
  "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"
}