tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateTasks

Last updated: 2024-08-08 15:32:07

    1. API Description

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

    This API is used to create and execute SQL tasks in batches.

    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: CreateTasks.
    Version Yes String Common Params. The value used for this API: 2021-01-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    DatabaseName Yes String Database name. If there is a database name in the SQL statement, the database in the SQL statement will be used first; otherwise, the database specified by this parameter will be used (note: when submitting the database creation SQL statement, passed in an empty string for this field).
    Tasks Yes TasksInfo SQL task information
    DatasourceConnectionName No String Data source name. Default value: DataLakeCatalog.
    DataEngineName No String Compute engine name. If this parameter is not specified, the task will be submitted to the default engine.
    ResourceGroupName No String Resource group name of the spark cluster

    3. Output Parameters

    Parameter Name Type Description
    BatchId String ID of the current batch of submitted tasks
    TaskIdSet Array of String Collection of task IDs arranged in order of execution
    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 Creating and executing SQL tasks in batch

    This example shows you how to create and execute SQL tasks in batches.

    Input Example

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

{
    "Tasks": {
        "TaskType": "SQLTask",
        "SQL": "U0VMRUNUICogRlJPTSBgdGVzdGh5d2AuYHRlc3QxMDBtYCBMSU1JVCAxMDs=",
        "Config": [
            {
                "Key": "",
                "Value": ""
            }
        ],
        "FailureTolerance": "Proceed"
    },
    "DatabaseName": "testdb",
    "DatasourceConnectionName": "DataLakeCatalog"
}

    Output Example

    {
    "Response": {
        "BatchId": "batch-45nyt3ee",
        "RequestId": "b577857e-041f-46c7-b5cf-4b3d3f50bc51",
        "TaskIdSet": [
            "e9663251-3a14-423a-b003-13c77c3fae11"
        ]
    }
}

    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.NoPermissionToUseTheDataEngine The user does not have permission to specify the engine.
    FailedOperation.SQLTaskParseFailed Syntax parsing failed. Please verify and try again.
    InternalError An internal error occurred.
    InternalError.DBError A database error occurred.
    InternalError.InternalSystemException The business system is abnormal. Please try again or submit a ticket to contact us.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.DataEngineOnlySupportSQL The current task only supports SQL engine operation.
    InvalidParameter.ImageEngineTypeNotMatch The specified engine type does not match. Currently, only SparkSQL, PrestoSQL, and SparkBatch are supported.
    InvalidParameter.ImageIsPublicNotMatch The specified isPublic does not match. Currently, it only supports 1: public and 2: private.
    InvalidParameter.ImageParameterNotFound The specified cluster image parameter does not exist.
    InvalidParameter.ImageParameterSubmitMethodNotMatch The specified cluster image ParameterSubmitMethod does not match. Currently, only User and BackGround are supported.
    InvalidParameter.ImageParameterTypeNotMatch The specified cluster image ParameterType does not match. Currently, it only supports 1: session; 2: common; 3: cluster.
    InvalidParameter.InvalidConfigKeyNotFound The specified task parameter Key value does not exist.
    InvalidParameter.InvalidConfigValueLengthOutLimit The length of the specified task parameter Value exceeds the limit.
    InvalidParameter.InvalidConfigValueRegexpNotMatch The specified task parameter Value does not conform to the rules.
    InvalidParameter.InvalidDataEngineName The data engine name is invalid.
    InvalidParameter.InvalidFailureTolerance The task fault tolerance type is wrong. Currently, only Proceed/Terminate is supported.
    InvalidParameter.InvalidSQL SQL parsing failed.
    InvalidParameter.InvalidSQLNum The number of executed SQL statements is incorrect. The number of SQL statements must be greater than or equal to 1 and less than or equal to 50.
    InvalidParameter.InvalidStoreLocation The storage location is incorrect.
    InvalidParameter.InvalidTaskType The TaskType is incorrect. The Spark engine task type is SparkSQLTask, and the Presto engine task type is SQLTask.
    InvalidParameter.InvalidWhiteListKey There is an error in getting an allowlist. Please try again or submit a ticket to contact us.
    InvalidParameter.ParameterNotFoundOrBeNone The parameter is not found or empty.
    InvalidParameter.SQLBase64DecodeFail Base64 parsing of the SQL script failed.
    InvalidParameter.SQLParameterPreprocessingFailed SQL parameter preprocessing failed.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.DataEngineNotFound The specified engine does not exist.
    ResourceNotFound.DataEngineNotRunning The specified engine is not running.
    ResourceNotFound.DataEngineNotUnique The specified engine already exists.
    ResourceNotFound.DefaultDataEngineNotFound No default engine can be found.
    ResourceNotFound.ResultOutputPathNotFound The result path was not found.
    ResourceUnavailable.BalanceInsufficient The account balance is insufficient to run the SQL task.
    UnauthorizedOperation.UseComputingEngine The sub-user does not have permission to use the compute engine.
    UnsupportedOperation.UnsupportedFileType The current file format is not supported. Currently, it only supports json/csv/avro/orc/parquet.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy