TI-ONE 训练平台模型训练任务列表-任务训练相关接口-API 中心-腾讯云

1. 接口描述

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

训练任务列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTrainingTasks。
Version	是	String	公共参数，本接口取值：2021-11-11。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	过滤器，eg：[{ "Name": "Id", "Values": ["train-23091792777383936"] }] 取值范围： Name（名称）：task1 Id（task ID）：train-23091792777383936 Status（状态）：SUBMITTING/PENDING/STARTING / RUNNING / STOPPING / STOPPED / FAILED / SUCCEED / SUBMIT_FAILED ResourceGroupId（资源组 Id）：trsg-kvvfrwl7 Creator（创建者 uin）：100014761913 ChargeType（计费类型）：PREPAID（预付费）/ POSTPAID_BY_HOUR（后付费） CHARGE_STATUS（计费状态）：NOT_BILLING（未开始计费）/ BILLING（计费中）/ ARREARS_STOP（欠费停止）示例值：[{ "Name": "TaskStatus", "Values": ["Running"] }]
TagFilters.N	否	Array of TagFilter	标签过滤器，eg：[{ "TagKey": "TagKeyA", "TagValue": ["TagValueA"] }] 示例值：[{ "TagKey": "TagKeyA", "TagValue": ["TagValueA"] }]
Offset	否	Integer	偏移量，默认为0 示例值：1
Limit	否	Integer	返回数量，默认为10，最大为50 示例值：10
Order	否	String	输出列表的排列顺序。取值范围：ASC（升序排列）/ DESC（降序排列），默认为DESC 示例值：DESC
OrderField	否	String	排序的依据字段，取值范围 "CreateTime" 、"UpdateTime"、"StartTime"，默认为UpdateTime 示例值：CreateTime

3. 输出参数

参数名称	类型	描述
TrainingTaskSet	Array of TrainingTaskSetItem	训练任务集
TotalCount	Integer	数量示例值：10
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 训练任务列表

获取训练任务列表

输入示例

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

{
    "Filters": [
        {
            "Fuzzy": true,
            "Values": [
                "string"
            ],
            "Name": "string",
            "Negative": true
        }
    ],
    "TagFilters": [
        {
            "TagValues": [
                "string"
            ],
            "TagKey": "string"
        }
    ],
    "Limit": 1,
    "OrderField": "string",
    "Offset": 1,
    "Order": "string"
}

输出示例

{
    "Response": {
        "TrainingTaskSet": [
            {
                "Id": "abc",
                "Name": "abc",
                "FrameworkName": "abc",
                "FrameworkVersion": "abc",
                "FrameworkEnvironment": "abc",
                "ChargeType": "abc",
                "ChargeStatus": "abc",
                "ResourceGroupId": "abc",
                "ResourceConfigInfos": [
                    {
                        "Role": "abc",
                        "Cpu": 1,
                        "Memory": 1,
                        "GpuType": "abc",
                        "Gpu": 1,
                        "InstanceType": "abc",
                        "InstanceNum": 1,
                        "InstanceTypeAlias": "abc",
                        "RDMAConfig": {
                            "Enable": true
                        }
                    }
                ],
                "TrainingMode": "abc",
                "Status": "abc",
                "RuntimeInSeconds": 1,
                "CreateTime": "abc",
                "StartTime": "abc",
                "EndTime": "abc",
                "Output": {
                    "Bucket": "abc",
                    "Region": "abc",
                    "Paths": [
                        "abc"
                    ]
                },
                "FailureReason": "abc",
                "UpdateTime": "abc",
                "BillingInfo": "abc",
                "ResourceGroupName": "abc",
                "ImageInfo": {
                    "ImageType": "abc",
                    "ImageUrl": "abc",
                    "RegistryRegion": "abc",
                    "RegistryId": "abc"
                },
                "Message": "abc",
                "Tags": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ],
                "CallbackUrl": "abc"
            }
        ],
        "TotalCount": 1,
        "RequestId": "abc"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.QueryResourceSpecFailed	查询计费项详情失败。
InternalError	内部错误。
InternalError.QueryBindingTagsFailed	查询标签失败。
InternalError.QueryPriceFailed	询价失败
InternalError.QueryResourceGroupNamesFailed	查询预付费资源组名称失败
InternalError.QueryResourceSpecFailed	查询资源套餐规格失败
InvalidParameter	参数错误。
InvalidParameterValue.FrameworkVersionNotSupport	训练框架对应的版本不支持，请阅读文档查看TIONE目前支持的框架和版本。
InvalidParameterValue.PageLimitExceeded	分页查询limit超出限制
UnsupportedOperation	操作不支持。

模型训练任务列表

本页目录：