tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CommitIntegrationTask

Last updated: 2024-06-24 16:58:51

1. API Description

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

Submit integration task

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: CommitIntegrationTask.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TaskId Yes String Task ID
ProjectId Yes String Project ID
CommitType No Integer 0. Only submit, 1. Start immediately, 2. Stop online jobs, discard job state data, restart, 3. Pause online jobs, keep job state data, continue running, 4. Keep job state data, continue running
TaskType No Integer Real-time task 201 Offline task 202 Default is real-time task
ExtConfig.N No Array of RecordField Additional parameters
VersionDesc No String Submit version description
InstanceVersion No Integer Submit version number
EventDesc No String Describe the type of front-end operation

3. Output Parameters

Parameter Name Type Description
Data Boolean Operation Success or Failure Indicator
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 1

Input Example

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

{
    "TaskId": "kb947c997-4f91-4a1f-913d-06f66a5fb927",
    "ProjectId": "1486804694126882816",
    "CommitType": 1,
    "TaskType": 201,
    "VersionDesc": "v1",
    "InstanceVersion": 3
}

Output Example

{
    "Response": {
        "Error": {
            "Code": "UnsupportedOperation",
            "Message": "CloudApiException: The current task is locked by 100028625403 and cannot be committed"
        },
        "RequestId": "6a160ebb-720b-47a7-8f88-4e30f033955d"
    }
}

Example2 Submit integration task

Submit integration task

Input Example

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

{
    "TaskId": "3cd6b1b3-76a0-4147-8f0e-6df206bc58c0",
    "ProjectId": "1",
    "CommitType": 0,
    "TaskType": 1,
    "ExtConfig": [
        {
            "Name": "name1",
            "Value": "1"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "as1cs2c123asyi23bh213cc",
        "Data": true
    }
}

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
AuthFailure CAM Signature/Authentication Error.
AuthFailure.SignatureExpire Not logged in or login has expired.
FailedOperation Operation Failure.
InternalError An internal error occurs.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
LimitExceeded Quota limit exceeded.
MissingParameter Missing Parameter Error.
OperationDenied Operation Rejected.
RequestLimitExceeded The number of requests exceeded the frequency limit.
ResourceInUse Resource Occupied.
ResourceInsufficient Insufficient resources.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource Unavailable.
UnauthorizedOperation Unauthorized Operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation Operation not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy