1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
本接口用于创建定时SQL分析任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateScheduledSql。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SrcTopicId | 是 | String | 源日志主题 示例值:6ef60bec-0242-43af-bb20-270359fbxxx |
Name | 是 | String | 任务名称 示例值:test |
EnableFlag | 是 | Integer | 任务启动状态. 1开启, 2关闭 示例值:1 |
DstResource | 是 | ScheduledSqlResouceInfo | 定时SQL分析目标日志主题 |
ScheduledSqlContent | 是 | String | 查询语句 示例值:* | select count(*) |
ProcessStartTime | 是 | Integer | 调度开始时间,Unix时间戳,单位ms 示例值:1690515360000 |
ProcessType | 是 | Integer | 调度类型,1:持续运行 2:指定时间范围 示例值:1 |
ProcessPeriod | 是 | Integer | 调度周期(分钟) 示例值:2 |
ProcessTimeWindow | 是 | String | 单次查询的时间窗口,如果您的目标主题为指标主题,建议该参数的大小不超过30分钟,否则可能转指标失败。 示例值:@m-15m,@m |
ProcessDelay | 是 | Integer | 执行延迟(秒) 示例值:60 |
SrcTopicRegion | 是 | String | 源topicId的地域信息 示例值:ap-guangzhou |
ProcessEndTime | 否 | Integer | 调度结束时间,当ProcessType=2时为必传字段, Unix时间戳,单位ms 示例值:1690515440000 |
SyntaxRule | 否 | Integer | 查询语法规则。 默认值为0。0:Lucene语法,1:CQL语法 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务id 示例值:6ef60bec-0242-43af-bb20-270359fxxxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建ScheduledSQL任务
创建ScheduledSQL任务
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateScheduledSql
<公共请求参数>
{
"EnableFlag": 1,
"ProcessStartTime": 1690515360000,
"Name": "test",
"DstResource": {
"TopicId": "6ef60bec-0242-43af-bb20-270359fbxxxx",
"Region": "ap-guangzhou",
"BizType": 1,
"MetricName": "pv"
},
"ProcessTimeWindow": "@m-15m,@m",
"ProcessPeriod": 5,
"ScheduledSqlContent": "* | select count(*) as pv",
"SrcTopicId": "6ef60bec-0242-43af-bb20-270359fbxxxxx",
"ProcessDelay": 0,
"ProcessType": 1,
"SrcTopicRegion": "ap-guangzhou",
"ProcessEndTime": 1690515440000
}
输出示例
{
"Response": {
"TaskId": "abdcebec-0242-43af-bb20-270359fb54a7",
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DataFromTaskConflict | 数据加工任务冲突。 |
InvalidParameter.InvalidEtlContent | 无效的数据加工语句。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.ACLFailed | ACL校验失败。 |
OperationDenied.AccountDestroy | 账户已销毁。 |
OperationDenied.AccountIsolate | 账户欠费。 |
OperationDenied.AccountNotExists | 账户不存在。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.TopicNotExist | 日志主题不存在。 |