1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
修改AI 定时任务。
支持部分更新,仅更新传入的可选字段。触发器列表通过 UpdateTriggers 标志控制是否全量替换。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyAISchedule。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ScheduleId | 否 | String | AI 定时任务 ID。可通过 CreateAISchedule 接口获取。 示例值:sched-a1b2c3d4 |
| Name | 否 | String | 任务名称。最大 128 字符。 示例值:每日安全扫描 |
| Prompts | 否 | String | 执行提示词。最大 2048 字符。 示例值:请执行全量安全扫描 |
| MaxFireCount | 否 | Integer | 最大触发次数,0 表示无限制。 示例值:0 |
| StartTime | 否 | Integer | 生效开始时间,Unix 毫秒时间戳,0 表示立即生效。 示例值:1704067200000 |
| EndTime | 否 | Integer | 生效结束时间,Unix 毫秒时间戳,0 表示永不过期。 示例值:0 |
| Triggers.N | 否 | Array of AiScheduleTriggerInfo | 触发器列表,当 UpdateTriggers 为 true 时全量替换。 |
| UpdateTriggers | 否 | Boolean | 是否更新触发器列表。取值:true(使用 Triggers 字段全量替换)、false(不更新)。 示例值:false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改定时记录
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAISchedule
<公共请求参数>
{
"ScheduleId": "sched-a1b2c3d4",
"Name": "每日安全扫描",
"Prompts": "请执行全量安全扫描",
"MaxFireCount": 0,
"StartTime": 1704067200000,
"EndTime": 0,
"Triggers": [
{
"TriggerId": "trig-x1y2z3",
"TriggerType": 1
}
],
"UpdateTriggers": false
}
输出示例
{
"Response": {
"RequestId": "afacf06f-cf9f-44a5-8c96-70a4bd9bfe46"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |