tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
日志服务
    文档
    Download PDF

    DescribeDataTransformInfo

    最后更新时间：2024-04-15 19:58:39
    下载PDF

      1. API Description

      Domain name for API request: cls.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.

      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: DescribeDataTransformInfo.
      Version Yes String Common Params. The value used for this API: 2020-10-16.
      Region No String Common Params. This parameter is not required for this API.
      Filters.N No Array of Filter
    • taskName

      Filter by processing task name.
      Type: String

      Required: No


    • taskId

      Filter by processing task ID.
      Type: String

      Required: No


    • srctopicId

      Filter by source topic ID.
      Type: String

      Required: No

      Each request can have up to 10 Filters and 100 Filter.Values.
      		•
      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 Task ID, which is required when Type is set to 1

      3. Output Parameters

      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.

      4. Example

      Example1 Getting the Basic Information of Data Processing Tasks

      This example shows you how to get the basic information of data processing tasks.

      Input Example

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

{}

      Output Example

      {
    "Response": {
        "TotalCount": 1,
        "DataTransformTaskInfos": [
            {
                "Status": 0,
                "EnableFlag": 0,
                "UpdateTime": "2021-08-08 12:12:12",
                "LastEnableTime": "xxxx",
                "Name": "My data processing task",
                "LogsetId": "xxxx",
                "SrcTopicName": "My log topic",
                "SrcTopicId": "61b9XXXX-971a-48c7-984d-ca147cf242c1",
                "DstResources": [
                    {
                        "TopicId": "3d9bXXXX-05a4-4435-ac65-f43e684329b3",
                        "Alias": "Alias"
                    }
                ],
                "TaskId": "e4fcXXXX-5e8a-4fe0-b52c-76eeca53e9af",
                "EtlContent": "ields_set()",
                "Type": 0,
                "CreateTime": "2021-08-0712: 12: 12"
            }
        ],
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

      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
      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.
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款