tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CheckFunction

Last updated: 2024-04-15 19:58:40

1. API Description

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

This API is used to verify the syntax of data processing DSL functions.

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: CheckFunction.
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.
EtlContent Yes String Processing statement entered by the user
DstResources.N No Array of DataTransformResouceInfo Target topic ID and alias of the data processing task
FuncType No Integer Type of the target topic for data processing. Valid values: 1 (fixed Topic) and 2 (dynamic creation)

3. Output Parameters

Parameter Name Type Description
ErrorCode Integer Failure error code
ErrorMsg String Failure error message
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 Verifying the Syntax of the Data Processing Function

This example shows you how to verify the syntax of the data processing function.

Input Example

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckFunction
<Common request parameters>
{
    "EtlContent": "fields_set()",
    "DstResources": [
        {
            "TopicId": "x56493046-XXXX-4194-81f6-c2e75569b031",
            "Alias": "example"
        }
    ],
    "FuncType": 1
}

Output Example

{
    "Response": {
        "ErrorCode": 0,
        "ErrorMsg": "",
        "RequestId": "x56493046-XXXX-4194-81f6-c2e75569b031"
    }
}

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
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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy