1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询AI 定时任务列表。
支持分页查询和状态过滤,返回定时任务列表及总条数。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAIScheduleList。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Offset | 否 | Integer | 分页偏移量,默认 0。 示例值:0 |
| Limit | 否 | Integer | 分页大小,默认 20,最大 100。 示例值:10 |
| Status | 否 | Integer | 状态过滤。取值:0(全部)、1(已启用)、2(已停用),默认 0。 示例值:0 |
| ScheduleId | 否 | String | 定时任务ID,可选,为空时则全量查询 示例值:a156***29702 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ScheduleSet | Array of AiScheduleInfo | AI 定时任务列表。 |
| TotalCount | Integer | 总条数。 示例值:7 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 1
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAIScheduleList
<公共请求参数>
{
"Offset": 0,
"Limit": 10,
"Status": 0,
"ScheduleId": "a156***************************29702"
}
输出示例
{
"Response": {
"ScheduleSet": [
{
"CreateTime": 1776841342887,
"CurrentFireCount": 0,
"EndTime": 0,
"Identity": {
"AppId": 260083796,
"BotId": "aibn2Vz1_iZ1R2B5mGjZ5o9ph3SmfjdLEQO",
"Channel": "wecom",
"ChatId": "T70030002A",
"SubUin": "",
"Uin": "700002365149",
"UserId": "T70030002A"
},
"MaxFireCount": 0,
"Name": "CSIP周报定时发送",
"Prompts": "生成云安全中心周报,整理成PDF和PPT,通过email技能发送到rainewang@tencent.com",
"ScheduleId": "586ecd9e-d140-45bb-889e-3476efaa4b50",
"StartTime": 0,
"Status": 1,
"Triggers": [
{
"TriggerId": "8a09c63b-a324-4707-a0e5-3a6722c20da1",
"TriggerType": 1
}
],
"UpdateTime": 1776841342887
}
],
"TotalCount": 7,
"RequestId": "666d1958-ca82-47a4-b3d9-dd49b2caa6c8"
}
}
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 | 未授权操作。 |