tencent cloud

All product documents
APIs
DocumentationAPIsEvent BridgeData Transformer APIsCreateTransformation
CreateTransformation
Last updated: 2023-12-01 16:50:05
CreateTransformation
Last updated: 2023-12-01 16:50:05

1. API Description

Domain name for API request: eb.tencentcloudapi.com.

This API is used to create a transformer.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CreateTransformation.
Version Yes String Common Params. The value used for this API: 2021-04-16.
Region No String Common Params. This parameter is not required for this API.
EventBusId Yes String Event bus ID
RuleId Yes String Rule ID
Transformations.N Yes Array of Transformation Transformation rule list (currently, only one is supported)

3. Output Parameters

Parameter Name Type Description
TransformationId String Generated transformer ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a transformer

Input Example

POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTransformation
<Common request parameters>

{
    "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"
                    }
                ]
            }
        }
    ]
}

Output Example

{
    "Response": {
        "TransformationId": "tsfm-xxxxxxxx",
        "RequestId": "e3d43926-c2cd-49f2-97f0-53db21e6fcea"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue.Transformations Failed to create the data transformation task: The parameter is invalid. Please check and try again.
ResourceNotFound.EventBus The specified event bus was not found. Please create it and try again.
ResourceNotFound.Rule The specified Rule was not found. Please create it and try again.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support