Domain name for API request: csip.intl.tencentcloudapi.com.
Modify a scheduled AI task.
Partial update is supported. Only the passed-in optional fields are updated. Whether the trigger list is fully replaced is controlled by the UpdateTriggers flag.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyAISchedule. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| ScheduleId | No | String | ID of the AI scheduled task. It can be obtained through the CreateAISchedule API. |
| Name | No | String | Task name. Maximum 128 characters. |
| Prompts | No | String | Execute the prompt content. Maximum 2048 characters. |
| MaxFireCount | No | Integer | Maximum trigger count. 0 indicates unlimited. |
| StartTime | No | Integer | Start of effective time, Unix millisecond timestamp. 0 indicates immediate effect. |
| EndTime | No | Integer | Effective end time, Unix millisecond timestamp. 0 means never expires. |
| Triggers.N | No | Array of AiScheduleTriggerInfo | Trigger list. When UpdateTriggers is true, full replacement is applied. |
| UpdateTriggers | No | Boolean | Whether to update the trigger list. Value: true (use the Triggers field for full replacement), false (does not update). |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAISchedule
<Common request parameters>
{
"ScheduleId": "sched-a1b2c3d4",
"Name": "Daily security scan"
"Prompts": "Please execute a full security scan"
"MaxFireCount": 0,
"StartTime": 1704067200000,
"EndTime": 0,
"Triggers": [
{
"TriggerId": "trig-x1y2z3",
"TriggerType": 1,
"CronConfig": {
"CronExpression": "0 9 * * 1-5"
},
"FixConfig": {
"FireTime": 1704110400000
}
}
],
"UpdateTriggers": false
}{
"Response": {
"RequestId": "afacf06f-cf9f-44a5-8c96-70a4bd9bfe46"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback