TI-ONE 训练平台查询标注任务列表

1. 接口描述

接口请求域名： tione.tencentcloudapi.com 。

本接口（DescribeAnnotatedTaskList）用于查询用户标注任务详细信息列表；支持各种过滤条件；

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAnnotatedTaskList。
Version	是	String	公共参数，本接口取值：2021-11-11。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	是	Integer	偏移量，默认为0 示例值：0
Limit	是	Integer	页面大小，默认为10 示例值：10
Filters.N	否	Array of Filter	过滤条件数组，支持数据集ID，标注场景、任务状态、数据集名称、人物名称的过滤，后面两个支持模糊查询
TagFilters.N	否	Array of TagFilter	标签过滤条件
Order	否	String	排序方向：Asc Desc 示例值：Desc
OrderField	否	String	排序字段示例值：CreateTime

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	任务列表总数量示例值：10
TaskList	Array of AnnotationTaskInfo	标注任务详情列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询标注任务列表

输入示例

POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAnnotatedTaskList
<公共请求参数>

{
    "Limit": 10,
    "Offset": 0,
    "Order": "DESC",
    "OrderField": "CreateTime",
    "Filters": []
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "TaskList": [
            {
                "TaskId": "373kxtfvtmv4",
                "TaskName": "dwfwf",
                "DatasetId": "373kxtfvtmv4",
                "DatasetName": "分割检测类",
                "SceneName": "Image_Classification",
                "LabelValueList": [
                    {
                        "LabelName": "mockname",
                        "LabelColor": "#FF0000"
                    }
                ],
                "Status": 2,
                "AbnormalMsg": "",
                "IsSubmitting": false,
                "CamTagList": [
                    {
                        "Key": "mockkey",
                        "Value": "mockvalue"
                    }
                ],
                "TaskNote": "",
                "DataSetVersion": "v3",
                "NumAnnotated": 0,
                "NumTotal": 31,
                "CreateTime": 1642504245,
                "OcrToolType": 0,
                "OcrTextAttributeAnnotateEnable": false,
                "ExportFormat": "ANNOTATION_FORMAT_TI",
                "SubmittingErrorMsg": "",
                "OcrAnnotationContentType": 0,
                "EnableAuxiliaryAnnotation": false
            }
        ],
        "RequestId": "d78711c1-02b1-452e-a447-49e402a014a0"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation.ExecTagFail	标签操作失败。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
OperationDenied	操作被拒绝。

查询标注任务列表

本页目录：