tencent cloud

APIs

DocumentaçãoAPIsCloud Security CenterCloud Security AI Assistant APIsCreateAISchedule

CreateAISchedule

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-01 10:03:33

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Create an AI scheduled task.

Create an AI scheduled task by entering the task name, prompt content, and trigger configuration. The AI scheduled task ID will be returned after successful creation.

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: CreateAISchedule.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
Name No String

Task name. Maximum 128 characters.
Prompts No String

Execute the prompt content. Maximum 2048 characters.
Triggers.N No Array of AiScheduleTriggerInfo

Trigger list. Multiple triggers have an "or" relationship, and any one of them triggers the action.
MaxFireCount No Integer

Maximum trigger count. 0 indicates unlimited.
StartTime No Integer

Start of effective time, Unix millisecond timestamp. 0 means effective immediately.
EndTime No Integer

Expiration time, Unix millisecond timestamp. 0 means never expires.

3. Output Parameters

Parameter Name Type Description
ScheduleId String

ID of the AI scheduled task.
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 a Scheduled Task

Input Example

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

{
"Name": "Daily security scan"
"Prompts": "Execute a full security scan and generate a report"
    "Triggers": [
        {
            "TriggerId": "trig-x1y2z3",
            "TriggerType": 1,
            "CronConfig": {
                "CronExpression": "0 9 * * 1-5"
            },
            "FixConfig": {
                "FireTime": 1704110400000
            }
        }
    ],
    "MaxFireCount": 0,
    "StartTime": 1704067200000,
    "EndTime": 0
}

Output Example

{
    "Response": {
        "ScheduleId": "sched-mock-001",
        "RequestId": "41b66490-3a6d-4ea1-a40e-7481b3db1500"
    }
}

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 failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
MissingParameter Parameters are missing.
UnauthorizedOperation Unauthorized operation.
Anterior: DescribeKBDetailPróximo: DeleteAISchedule

Ajuda e Suporte

Esta página foi útil?

comentários