Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to create a scheduled SQL analysis task.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateScheduledSql. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| SrcTopicId | Yes | String | Source log topic ID - Obtain the log topic ID by searching the log topic list. |
| Name | Yes | String | Task name, 0-255 characters |
| EnableFlag | Yes | Integer | Task start status. 1: Enabled, 2: Disabled |
| DstResource | Yes | ScheduledSqlResouceInfo | Target log topic for scheduled SQL analysis |
| ScheduledSqlContent | Yes | String | Query statement |
| ProcessStartTime | Yes | Integer | Schedule start time, Unix timestamp, in milliseconds |
| ProcessType | Yes | Integer | Schedule Type: 1 Continuous Running 2 Specified Time Range |
| ProcessPeriod | Yes | Integer | Scheduling Interval (Minutes), 1-1440 minutes |
| ProcessTimeWindow | Yes | String | Time window for a single query. If your target topic is a metric topic, it is recommended that the size of this parameter not exceed 30 minutes, otherwise, metric conversion may fail. |
| ProcessDelay | Yes | Integer | Execution delay (seconds), 0-120 seconds, default 60 seconds |
| SrcTopicRegion | Yes | String | Regional information of the source topicId. For supported regions, see the region list document. |
| ProcessPeriodUnit | No | Integer | Scheduling Time Unit Value ranges from 1 to 2 Default value: 1 The default value is 1 (minute), and the additional value is 2 (second). |
| ProcessEndTime | No | Integer | Schedule End Time, required when ProcessType=2, Unix timestamp, in milliseconds |
| SyntaxRule | No | Integer | Query syntax rules. Default value: 0. 0: Lucene syntax, 1: CQL syntax |
| HasServicesLog | No | Integer | Whether to enable delivery service log. 1: Disabled, 2: Enabled. |
| FullQuery | No | Integer | Full-text search tag. 1: Off, 2: On. Default: 1 |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to create a scheduled SQL task.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateScheduledSql
<Common request parameters>
{
"EnableFlag": 1,
"ProcessStartTime": 1690515360000,
"Name": "scheduler_sql_delete_task",
"DstResource": {
"TopicId": "6ef60bec-xxxx-xxxx-bb20-270359fbxxxx",
"Region": "ap-guangzhou",
"BizType": 1,
"MetricName": "pv"
},
"ProcessTimeWindow": "@m-15m,@m",
"ProcessPeriod": 5,
"ScheduledSqlContent": "* | select count(*) as pv",
"SrcTopicId": "6ef60bec-xxxx-xxxx-bb20-270359fbxxxxx",
"ProcessDelay": 0,
"ProcessType": 1,
"SrcTopicRegion": "ap-guangzhou",
"ProcessEndTime": 1690515440000
}
{
"Response": {
"TaskId": "abdcebec-xxxx-xxxx-bb20-270359fb54a7",
"RequestId": "6ef60bec-xxxx-xxxx-bb20-270359fb54a7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.DataFromTaskConflict | There is a data processing task conflict. |
| InvalidParameter.InvalidEtlContent | The data processing statement is invalid. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
文档反馈