1. 接口描述
接口请求域名: workbuddyenterprise.tencentcloudapi.com 。
部分更新自动化任务配置(Patch 语义:仅传递需要更新的字段),支持启停状态切换。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyScheduledTask。 |
| Version | 是 | String | 公共参数,本接口取值:2026-07-09。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| TaskId | 是 | String | 任务 ID 示例值:2117224391753601024 |
| TaskName | 否 | String | 任务名称 示例值:测试任务 |
| Description | 否 | String | 任务描述 示例值:用于测试验证的任务 |
| AgentConfig | 否 | AgentConfig | 任务关联的 Agent 配置 |
| CronExpr | 否 | String | Cron 表达式 示例值:0 00 09 * * * |
| Status | 否 | String | 任务状态:ACTIVE(启用)/ PAUSED(暂停)/ DISABLED(停用) 示例值:ACTIVE |
| EffectiveStart | 否 | String | 生效日期开始时间(YYYY-MM-DD 格式),传空串清除,不传保持原值 示例值:2026-11-02 |
| EffectiveEnd | 否 | String | 生效日期结束时间(YYYY-MM-DD 格式),传空串清除,不传保持原值 示例值:2026-11-07 |
| DeliveryTargetSet.N | 否 | Array of DeliveryTarget | 投递目标集合(部分更新时整体替换) |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改任务
输入示例
POST / HTTP/1.1
Host: workbuddyenterprise.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyScheduledTask
<公共请求参数>
{
"TaskId": 1001,
"TaskName": "每日晨报v2",
"DeliveryTargetSet": [
{
"Type": "BOT_CHANNEL",
"Enabled": true,
"Options": {
"ChannelType": "QQ",
"ChannelId": "1905263717",
"RecipientIdSet": [
"oc_xxx",
"oc_yyy"
]
}
}
]
}
输出示例
{
"Response": {
"RequestId": "3c6d138e-1234-5678-9abc-def012345678"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.IdentityNotFound | AuthFailure.IdentityNotFound |
| AuthFailure.IdentityResolutionFailed | AuthFailure.IdentityResolutionFailed |
| FailedOperation.EntitlementNotFound | FailedOperation.EntitlementNotFound |
| InternalError.BizException | InternalError.BizException |
| InternalError.EntitlementCheckFailed | InternalError.EntitlementCheckFailed |
| InternalError.FailedOperation | InternalError.FailedOperation |
| InternalError.InvalidCronExpression | InternalError.InvalidCronExpression |
| InternalError.InvalidParameter | InternalError.InvalidParameter |
| InternalError.LimitExceeded | InternalError.LimitExceeded |
| InternalError.MarshalFailed | InternalError.MarshalFailed |
| InternalError.NoResolver | InternalError.NoResolver |
| InternalError.Panic | InternalError.Panic |
| InternalError.PermissionDenied | InternalError.PermissionDenied |
| InternalError.ReadBodyFailed | InternalError.ReadBodyFailed |
| InternalError.RequestLimitExceeded | InternalError.RequestLimitExceeded |
| InternalError.ResolveEnterpriseFailed | InternalError.ResolveEnterpriseFailed |
| InternalError.ResourceInUse | InternalError.ResourceInUse |
| InternalError.ResourceNotFound | InternalError.ResourceNotFound |
| InternalError.ResourceUnavailable | InternalError.ResourceUnavailable |
| InternalError.TenantResolveFailed | InternalError.TenantResolveFailed |
| InternalError.Unknown | InternalError.Unknown |
| InvalidParameter.ActionNotFound | InvalidParameter.ActionNotFound |
| InvalidParameter.ActionRequired | InvalidParameter.ActionRequired |
| InvalidParameter.EmptyBody | InvalidParameter.EmptyBody |
| InvalidParameter.InvalidJSON | InvalidParameter.InvalidJSON |
| MissingParameter.UinRequired | MissingParameter.UinRequired |