Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to get the basic information of data processing tasks.
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: DescribeDataTransformInfo. |
| 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. |
| Filters.N | No | Array of Filter | - taskName Filter by [processing task name]. Type: String Required: No Example: test-task - taskId Filter by [processing task id]. Type: String Required: No Example: a3622556-6402-4942-b4ff-5ae32ec29810 Data processing task ID - Search the data processing task list basic information (https://www.tencentcloud.com/document/product/614/72182?from_cn_redirect=1) to get the data processing task ID. - topicId Filter by [source topicId]. Type: String Required: No Example: 756cec3e-a0a5-44c3-85a8-090870582000 Log topic ID -Obtain the log topic Id through Get Log Topic List. - status Filter by [Task running status]. 1: Preparing, 2: Running, 3: Stopping, 4: Stopped. Type: String Required: No Example: 1 - hasServiceLog Filter by [whether service logs are enabled]. 1: not enabled, 2: on. Type: String Required: No Example: 1 - dstTopicType Filter by [Target topic Type]. 1: Fixed, 2: Dynamic. Type: String Required: No Example: 1 Each request can have up to 10 Filters. The upper limit of Filter.Values is 100. |
| Offset | No | Integer | The pagination offset. Default value: 0. |
| Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100. |
| Type | No | Integer | Task type. Valid values: 1: Get the details of a single task. 2 (default): Get the task list. |
| TaskId | No | String | When Type is 1, this parameter is required. Data processing task ID - Search the data processing task list basic information (https://www.tencentcloud.com/document/product/614/72182?from_cn_redirect=1) to get the data processing task ID. |
| Parameter Name | Type | Description |
|---|---|---|
| DataTransformTaskInfos | Array of DataTransformTaskInfo | List of data processing tasks |
| TotalCount | Integer | Total tasks |
| 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. |
Obtaining the Basic Information of Data Processing Tasks
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataTransformInfo
<Common request parameters>
{
"Offset": 0,
"Limit": 1
}
{
"Response": {
"DataTransformTaskInfos": [
{
"BackupGiveUpData": false,
"BackupTopicID": "7557cd30-xxxx-xxxx-93d4-7-1254077820",
"CreateTime": "2024-11-29 03:46:57",
"DataTransformType": 0,
"DstResources": [
{
"Alias": "apilog",
"TopicId": "7f670b29-xxxx-xxxx-a62a-dd026fe66a9f"
}
],
"EnableFlag": 1,
"EtlContent": "log_keep(op_or(op_str_eq(v(\"logtype\"), \"apilog\"), op_str_eq(v(\"logtype\"), \"ailog\"), op_str_eq(v(\"logtype\"), \"stlog\"), op_str_eq(v(\"logtype\"), \"ranklog\")))\next_json(\"request\")\next_json(\"messages\")\next_json(\"response\")\next_json(\"completion\")",
"FailureLogKey": "ETLParseFailure",
"HasServicesLog": 2,
"KeepFailureLog": 1,
"LastEnableTime": "2024-11-29 14:43:18",
"LogsetId": "6718ed86-xxxx-xxxx-95e1-24012ee15caf",
"Name": "Extract ClsAi Text2CQL API Access Log"
"SrcTopicId": "0bb6b5e6-xxxx-469a-xxxx-ebbe250d083c",
"SrcTopicName": "[Test] Text2CQL - Full Logs"
"Status": 2,
"TaskDstCount": 1,
"TaskId": "5d368d4c-xxxx-xxxx-87a6-39802c1e0afe",
"Type": 1,
"UpdateTime": "2024-11-29 14:45:01"
}
],
"RequestId": "bf128f9e-xxxx-xxxx-a591-185220479620",
"TotalCount": 30
}
}
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. |
| FailedOperation.TagQpsLimit | The frequency of tag service requests is limited. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect 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