CreateCronJob

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: CreateCronJob.
Version	Yes	String	Common Params. The value used for this API: 2021-07-28.
Region	No	String	Common Params. This parameter is not required for this API.
Name	Yes	String	Name.
ProjectId	Yes	String	Project ID.
ScenarioId	Yes	String	Scenario ID.
ScenarioName	Yes	String	Scenario name.
FrequencyType	Yes	Integer	Execution frequency type: 1, execute once only; 2, Daily; 3, Weekly; 4, Advanced mode using cron expression.
CronExpression	Yes	String	Cron expression.
JobOwner	Yes	String	Cron job initiator.
EndTime	No	Timestamp ISO8601	End time.
NoticeId	No	String	Notice ID.
Note	No	String	Note.

3. Output Parameters

Parameter Name	Type	Description
CronJobId	String	Cron job ID.
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 Creates a cron job

Creates a cron job

Input Example

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

{
    "ProjectId": "project-xx",
    "ScenarioId": "scenario-xx",
    "ScenarioName": "scenario name",
    "Name": "cron name",
    "CronExpression": "*/1 * * * *",
    "FrequencyType": 1,
    "EndTime": "2020-09-22T00:00:00+00:00",
    "NoticeId": "notice-xx",
    "JobOwner": "tom"
}

Output Example

{
    "Response": {
        "RequestId": "req-xx",
        "CronJobId": "cron-xx"
    }
}

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

Tencent Cloud CLI 3.0

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.DbRecordCreateFailed	Failed to create database record.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Creates a cron job

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Tencent Big Model

Internet of Things

Stream Services

Cloud Real-time Rendering

Cloud Resource Management

More

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Management and Audit Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Voice Technology

Natural Language Processing

Communication

Media Process Services

Education Sevices

Developer Tools

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Image Creation

Optical Character Recognition

Interactive Video Services

Media SDK

Medical Services

Monitor and Operation

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Creates a cron job

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center