修改数据加工任务

最近更新时间:2024-05-08 01:12:26

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

本接口用于修改数据加工任务

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyDataTransform。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
TaskId String 加工任务id
示例值:abdeace6-9484-4d2e-b670-28289c42b60f
Name String 加工任务名称
示例值:task1
EtlContent String 加工语句。 当FuncType为2时,EtlContent必须使用log_auto_output

其他参考文档:

- 创建加工任务
- 函数总览
示例值:fields_drop("message")
EnableFlag Integer 任务启动状态. 默认为1,开启, 2关闭
示例值:1
DstResources.N Array of DataTransformResouceInfo 加工任务目的topic_id以及别名
HasServicesLog Integer 是否开启投递服务日志。1关闭,2开启
示例值:2

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改数据加工任务

数据加工提供对日志数据的过滤、清洗、脱敏、富化、分发等能力,可对标开源组件 Logstash。使用数据加工DSL(Domain Specified Language )函数,底层基于 Flink 实现,您可轻松处理日志流数据。

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDataTransform
<公共请求参数>

{
    "DstResources": [
        {
            "TopicId": "81XXXXe5-e39e-4a1e-b2d4-a778df97d825",
            "Alias": "别名"
        }
    ],
    "EnableFlag": 0,
    "EtlContent": "fields_set()",
    "Name": "我的数据加工",
    "TaskId": "e4fcXXXX-5e8a-4fe0-b52c-76eeca53e9af"
}

输出示例

{
    "Response": {
        "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。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.DataFromTaskConflict 数据加工任务冲突。
InvalidParameter.DataFromTaskNotExist 数据加工任务不存在。
InvalidParameter.InvalidEtlContent 无效的数据加工语句。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.ACLFailed ACL校验失败。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
ResourceNotFound 资源不存在。
ResourceNotFound.TopicNotExist 日志主题不存在。