Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to modify 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: ModifyScheduledSql. |
| 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. |
| TaskId | Yes | String | Task ID, obtained by searching the scheduled SQL analysis task list. |
| SrcTopicId | No | String | Source log topic, obtained via search scheduled SQL analysis task list |
| EnableFlag | No | Integer | Task start status. 1: Enabled, 2: Disabled |
| DstResource | No | ScheduledSqlResouceInfo | Target log topic for scheduled SQL analysis |
| ScheduledSqlContent | No | String | Query statement |
| ProcessPeriod | No | Integer | Scheduling Interval (Minutes), 1-1440 minutes |
| ProcessTimeWindow | No | String | Time window for a single query. Example: last 15 minutes |
| ProcessDelay | No | Integer | Execution delay (seconds), 0-120 seconds, default 60 seconds |
| SrcTopicRegion | No | String | Regional information of the source topicId. For supported regions, see the region list document. |
| Name | No | String | Task name, 0-255 characters |
| SyntaxRule | No | Integer | 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 query tag. 1: Off, 2: On. |
| ProcessPeriodUnit | No | Integer | Scheduling period unit Value ranges from 1 to 2 Default value: 1 Default value 1 (minute), other value 2 (second) |
| Parameter Name | Type | Description |
|---|---|---|
| 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 modify a scheduled SQL task.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyScheduledSql
<Common request parameters>
{
"EnableFlag": 1,
"TaskId": "6ef60bec-0242-43af-bb20-270359fxxxxx",
"DstResource": {
"TopicId": "6ef60bec-0242-43af-bb20-270359fxxxxx",
"Region": "ap-guangzhou",
"BizType": 1,
"MetricName": "pv"
},
"ProcessTimeWindow": "@m-15m,@m",
"ProcessPeriod": 5,
"ProcessPeriodUnit": 1,
"ScheduledSqlContent": "* | select count(*) as pv",
"SrcTopicId": "6ef60bec-0242-43af-bb20-270359fbxxxx",
"ProcessDelay": 0,
"SrcTopicRegion": "ap-guangzhou",
"Name": "task"
}
{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54ax"
}
}
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.DataFromTaskNotExist | Data processing task does not exist. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
피드백