1. 接口描述
接口请求域名： iss.tencentcloudapi.com 。
获取AI任务列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListAITasks。 |
| Version | 是 | String | 公共参数，本接口取值：2023-05-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| IsContainChannelList | 否 | Boolean | 是否包含通道列表。"true"代表包含通道列表，"false"代表不包含通道列表，默认为 false 示例值：true |
| IsContainTemplate | 否 | Boolean | 是否包含AI配置。"true"代表包含任务配置，"false"代表不包含任务配置，默认为 false。 示例值：true |
| PageNumber | 否 | Integer | 页码。默认为1 示例值：1 |
| PageSize | 否 | Integer | 每页数量。可选值1～200，默认为20 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | AI 任务数量 示例值：10 |
| Data | ListAITaskData | AI任务列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 失败示例
无效的分页大小
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListAITasks
<公共请求参数>
{
"IsContainChannelList": true,
"IsContainTemplate": true,
"PageNumber": 1,
"PageSize": 201
}输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.InvalidPageSize",
"Message": "无效的分页大小"
},
"RequestId": "f334da88-758f-43de-a0ae-f736c9c905ff"
}
}示例2 成功示例
无
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListAITasks
<公共请求参数>
{
"IsContainChannelList": true,
"IsContainTemplate": true
}输出示例
{
"Response": {
"Data": {
"List": [
{
"CallbackUrl": "http://********",
"ChannelList": [
"**********************"
],
"CreatedTime": "2023-06-07 00:35:36",
"Desc": "AI任务描述",
"Name": "ai-task",
"Status": "off",
"TaskId": "at**********************8",
"Templates": [
{
"AIConfig": {
"DetectType": "Pet",
"OperTimeSlot": [
{
"End": "20:00:00",
"Start": "10:00:00"
}
],
"TimeInterval": 10
},
"Tag": "AI"
}
],
"UpdatedTime": "2023-06-07 00:35:36"
}
]
},
"RequestId": "a9227772-9f97-4ec8-88bd-a1991b1363d4",
"TotalCount": 1
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidPageNumber | 无效的PageNumber |
| InvalidParameterValue.InvalidPageSize | 无效的PageSize |
