Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to modify a data processing 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: ModifyDataTransform. |
| 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 | Data processing task ID -Get the data processing task Id by searching data processing task list basic information. |
| Name | No | String | Processing task name -Get the name of a data processing task by searching data processing task list basic information. Name limit -Cannot be an empty string -Cannot contain character ' |
| EtlContent | No | String | Processing statement. When FuncType is 2, EtlContent must use log_auto_output. Other reference documents: -Create a processing task -Function overview |
| EnableFlag | No | Integer | Task status. Valid values: 1 (enabled) and 2 (disabled). |
| DstResources.N | No | Array of DataTransformResouceInfo | Destination topic ID and alias of the data processing task |
| BackupGiveUpData | No | Boolean | Whether to discard log data after the limit is exceeded |
| HasServicesLog | No | Integer | Whether to enable delivery service log. 1 for disabled, 2 for enabled |
| KeepFailureLog | No | Integer | Whether to keep the failure log status. Valid values: 1: no; 2: yes. |
| FailureLogKey | No | String | Field name of a failed log. |
| DataTransformSqlDataSources.N | No | Array of DataTransformSqlDataSource | External data source information |
| EnvInfos.N | No | Array of EnvInfo | Set environment variable |
| 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. |
Data processing provides the capacity to filter, clean, mask, enrich, and distribute log data, comparable to the open-source component Logstash. Using the data processing DSL (Domain Specified Language) function, with the underlying layer implemented based on Flink, you can easily process log stream data.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDataTransform
<Common request parameters>
{
"DstResources": [
{
"TopicId": "81XXXXe5-e39e-4a1e-b2d4-a778df97d825",
"Alias": "alias"
}
],
"EnableFlag": 1,
"EtlContent": "fields_set()",
"Name": "My Data Processing",
"TaskId": "e4fcXXXX-5e8a-4fe0-b52c-76eeca53e9af"
}
{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
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.CrossAccountConflict | Cross-account identifier error |
| InvalidParameter.DataFromTaskConflict | There is a data processing task conflict. |
| InvalidParameter.DataFromTaskNotExist | The data processing task does not exist. |
| 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.TopicNotExist | The log topic does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback