1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
创建任务式建模训练任务,Notebook,在线服务和批量预测任务日志下载任务API
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateExport。 |
| Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Service | 是 | String | 服务类型,TRAIN为任务式建模, NOTEBOOK为Notebook, INFER为在线服务, BATCH为批量预测枚举值:- TRAIN- NOTEBOOK- INFER- BATCH 示例值:TRAIN |
| ServiceId | 否 | String | 服务ID,和Service参数对应,不同Service的服务ID获取方式不同,具体如下:- Service类型为TRAIN: 调用DescribeTrainingTask接口查询训练任务详情,ServiceId为接口返回值中Response.TrainingTaskDetail.LatestInstanceId- Service类型为NOTEBOOK: 调用DescribeNotebook接口查询Notebook详情,ServiceId为接口返回值中Response.NotebookDetail.PodName- Service类型为INFER: 调用DescribeModelServiceGroup接口查询服务组详情,ServiceId为接口返回值中Response.ServiceGroup.Services.ServiceId- Service类型为BATCH: 调用DescribeBatchTask接口查询跑批任务详情,ServiceId为接口返回值中Response.BatchTaskDetail.LatestInstanceId 示例值:train-fsdjl-1 |
| StartTime | 否 | String | 日志查询开始时间(RFC3339格式的时间字符串),默认值为当前时间的前一个小时 示例值:2021-11-30T16:22:09+08:00 |
| EndTime | 否 | String | 日志查询结束时间(RFC3339格式的时间字符串),开始时间和结束时间必须同时填或同时不填,默认值为当前时间 示例值:2021-11-30T16:22:09+08:00 |
| Format | 否 | String | 日志导出数据格式。json,csv,默认为csv 示例值:csv |
| PodName | 否 | String | Pod的名称,即需要查询服务对应的Pod,和Service参数对应,不同Service的PodName获取方式不同,具体如下:- Service类型为TRAIN: 调用DescribeTrainingTaskPods接口查询训练任务pod列表,PodName为接口返回值中Response.PodNames- Service类型为NOTEBOOK: 调用DescribeNotebook接口查询Notebook详情,PodName为接口返回值中Response.NotebookDetail.PodName- Service类型为INFER: 调用DescribeModelService接口查询单个服务详情,PodName为接口返回值中Response.Service.ServiceInfo.PodInfos- Service类型为BATCH: 调用DescribeBatchTask接口查询跑批任务详情,PodName为接口返回值中Response.BatchTaskDetail. PodList注:支持结尾通配符* 示例值:train-fsdjl-1 |
| JobCategory | 否 | String | 描述任务的类型 示例值:FullManagedJob |
| InstanceType | 否 | String | 实例的类型 示例值:INFER |
| InstanceId | 否 | String | 查实例Id 示例值:ms-mcgxxxxx-1 |
| Type | 否 | String | 日志类型: PLATFORM_INIT, PLATFORM_SANITY_CHECK, USER 示例值:PLATFORM_INIT |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ExportId | String | 日志下载任务的ID 示例值:export-a85ac32e-42a8-49e3-b19b-c2a9ba831b40 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建日志下载任务
创建任务式建模训练任务,Notebook,在线服务和批量预测任务日志下载任务API
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateExport
<公共请求参数>
{
"Service": "TRAIN",
"ServiceId": "train-1051209973208673664-7zimubsiul1c",
"StartTime": "2022-01-10T12:15:03+08:00",
"EndTime": "2022-01-11T12:15:03+08:00",
"Format": "csv"
}
输出示例
{
"Response": {
"ExportId": "57196a6a-7622-47be-bc92-d2ebea959a0f",
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
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 | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |