tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateOfflineTask

Last updated: 2024-06-21 15:11:16

1. API Description

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

Create Offline 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: CreateOfflineTask.
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.
ProjectId Yes String Project ID
CycleStep Yes Integer Interval, optional, default is 1. Not null. Default is 1
DelayTime Yes Integer Delayed Execution Time, in minutes
EndTime Yes String Task End Data Time. Not Empty. Default to Current Time
Notes Yes String Remarks
StartTime Yes String Current date
TaskName Yes String Task Name
TypeId Yes Integer Keep it consistent with the previous call to the scheduling interface 27
TaskAction Yes String Time Specification, for monthly tasks specify days like 1,3, then enter 1,3. Not Empty. Default "" Monthly Task: For specific days like "1,3", specifying the end of the month cannot be combined with specific dates, can only be "L"
TaskMode Yes String Distinguish between canvas and form

3. Output Parameters

Parameter Name Type Description
TaskId String Task IDNote: This field may return null, indicating that no valid value can be obtained.
Data String Result
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 Create Offline Task

Create Offline Task

Input Example

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

{
    "ProjectId": "1486446569620893696",
    "CycleStep": 1,
    "DelayTime": 0,
    "EndTime": "2099-12-31 00:00:00",
    "Notes": "",
    "StartTime": "2022-04-11 00:00:00",
    "TaskName": "task test name",
    "TypeId": 27,
    "TaskAction": "",
    "TaskMode": "1"
}

Output Example

{
    "Response": {
        "TaskId": "20220411181355382",
        "Data": "true",
        "RequestId": "7508483f-5202-44b3-a846-8c6efb42acb0"
    }
}

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