1. 接口描述
接口请求域名: eb.tencentcloudapi.com 。
用于创建转换器
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTransformation。 |
Version | 是 | String | 公共参数,本接口取值:2021-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
EventBusId | 是 | String | 事件总线 id 示例值:eb-xxxxx |
RuleId | 是 | String | 规则id 示例值:rule-xxxxxx |
Transformations.N | 是 | Array of Transformation | 一个转换规则列表,当前仅限定一个;示例如下:[{"Extraction":{"ExtractionInputPath":"$.data.payload","Format":"JSON"},"EtlFilter":{"Filter":"{"source":"ckafka.cloud.tencent"}"},"Transform":{"OutputStructs":[{"Key":"op","Value":"$.op","ValueType":"JSONPATH"},{"Key":"table","Value":"$.source.table","ValueType":"JSONPATH"},{"Key":"id","Value":"$.after.id","ValueType":"JSONPATH"},{"Key":"app_id","Value":"$.after.app_id","ValueType":"JSONPATH"},{"Key":"spu_id","Value":"$.after.spu_id","ValueType":"JSONPATH"}]}}] 示例值:[{"Extraction":{"ExtractionInputPath":"$.data.payload","Format":"JSON"},"EtlFilter":{"Filter":"{"source":"ckafka.cloud.tencent"}"},"Transform":{"OutputStructs":[{"Key":"op","Value":"$.op","ValueType":"JSONPATH"},{"Key":"table","Value":"$.source.table","ValueType":"JSONPATH"},{"Key":"id","Value":"$.after.id","ValueType":"JSONPATH"},{"Key":"app_id","Value":"$.after.app_id","ValueType":"JSONPATH"},{"Key":"spu_id","Value":"$.after.spu_id","ValueType":"JSONPATH"}]}}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TransformationId | String | 生成的转换器id 示例值:tsfm-xxxxxxxxxxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建转换器
输入示例
POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTransformation
<公共请求参数>
{
"EventBusId": "eb-xxxxx",
"RuleId": "rule-xxxxx",
"Transformations": [
{
"Extraction": {
"ExtractionInputPath": "$",
"Format": "JSON"
},
"EtlFilter": {
"Filter": "{\"source\":\"ckafka.cloud.tencent\"}"
},
"Transform": {
"OutputStructs": [
{
"Key": "data",
"Value": "$.data",
"ValueType": "STRING"
},
{
"Key": "age",
"Value": "$.age",
"ValueType": "NUMBER"
}
]
}
}
]
}
输出示例
{
"Response": {
"TransformationId": "tsfm-xxxxxxxx",
"RequestId": "e3d43926-c2cd-49f2-97f0-53db21e6fcea"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.Transformations | 数据转换任务创建失败,配置参数取值与规范不符,请修正后再试。 |
ResourceNotFound.EventBus | 未找到指定事件集,请创建后再试。 |
ResourceNotFound.Rule | 未找到指定的Rule,请创建后再试。 |