1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
创建任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateAIWorkbenchTask。 |
| Version | 是 | String | 公共参数,本接口取值:2023-06-16。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Name | 否 | String | 任务名称 示例值:策略触发 |
| Description | 否 | String | 任务描述 示例值:用于测试任务创建 |
| AgentId | 否 | String | 关联 Agent ID 示例值:agt-**** |
| PromptTemplate | 否 | String | 提示词模板 示例值:任务目标:分析指定账号下近N天的告警历史分布情况,识别频繁告警的对象并进一步获取详细信息进行摘要分析,输出结构化告警分析报告 |
| OutputFormat | 否 | String | 输出格式: markdown / json 示例值:markdown |
| TriggerType | 否 | String | 触发类型: manual / cron / webhook 示例值:cron |
| CronExpr | 否 | String | Cron 表达式 示例值:* * * * * ? |
| CronTimezone | 否 | String | Cron 时区 示例值:Asia/Shanghai |
| ResourceMapId | 否 | String | 关联资源地图 ID 示例值:coll-**** |
| SkillIds.N | 否 | Array of String | 技能 ID 列表 示例值:["skl-****"] |
| McpEndpointIds.N | 否 | Array of String | MCP 端点 ID 列表 示例值:["mcp-****"] |
| TimeoutSec | 否 | Integer | 超时时间(秒) 示例值:600 |
| RetryCount | 否 | Integer | 重试次数 示例值:4 |
| Enabled | 否 | Boolean | 是否启用 示例值:true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务 ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:tsk-**** |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 测试任务创建
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIWorkbenchTask
<公共请求参数>
{
"Name": "测试任务",
"Description": "用于测试任务创建",
"AgentId": "agt-********",
"TriggerType": "cron",
"ResourceMapId": "coll-********",
"SkillIds": [
"skl-********"
],
"TimeoutSec": 61,
"RetryCount": 4,
"Enabled": true,
"McpEndpointIds": [
"mcp-********"
]
}
输出示例
{
"Response": {
"TaskId": "tsk-********",
"RequestId": "ea9b8eba-07bf-4384-a2db-6e316b6bcb2e"
}
}
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 | 参数错误。 |
| UnauthorizedOperation | 未授权操作。 |