1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
创建批量预测任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateBatchTask。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
BatchTaskName | 是 | String | 批量预测任务名称,不超过60个字符,仅支持中英文、数字、下划线"_"、短横"-",只能以中英文、数字开头 示例值:示例任务 |
ChargeType | 是 | String | 计费模式,eg:PREPAID 包年包月;POSTPAID_BY_HOUR 按量计费 示例值:POSTPAID_BY_HOUR |
ResourceConfigInfo | 是 | ResourceConfigInfo | 资源配置 |
Outputs.N | 是 | Array of DataConfig | 结果输出存储信息 示例值:[{"DataSourceType": "COS", "COSSource": { "Bucket": "test-1256581234", "Region": "ap-shanghai", "Paths": ["output/"]}}] |
LogEnable | 是 | Boolean | 是否上报日志 示例值:false |
ResourceGroupId | 否 | String | 包年包月资源组ID 示例值:rsc-123456789 |
Tags.N | 否 | Array of Tag | 标签配置 示例值:[] |
ModelInfo | 否 | ModelInfo | 服务对应的模型信息,有模型文件时需要填写 |
ImageInfo | 否 | ImageInfo | 自定义镜像信息 |
CodePackage | 否 | CosPathInfo | 代码包 |
DataConfigs.N | 否 | Array of DataConfig | 数据配置 示例值:[{"DataSourceType": "COS", "COSSource": { "Bucket": "test-1256581234", "Region": "ap-shanghai", "Paths": ["data/test/"]}}] |
LogConfig | 否 | LogConfig | 日志配置 |
VpcId | 否 | String | VPC Id 示例值:vpc-fgb3u1kx |
SubnetId | 否 | String | 子网Id 示例值:subnet-jhzi2m3j |
Remark | 否 | String | 备注 |
CallbackUrl | 否 | String | 任务执行结果回调URL,仅支持http和https。回调格式&内容详见: TI-ONE 接口回调说明 示例值:http://www.qq.com |
StartCmdBase64 | 否 | String | 以Base64方式编码的启动命令。假设启动命令是/app/run.sh,则此处输入参数应该为L2FwcC9ydW4uc2g=。 示例值:L2FwcC9ydW4uc2g= |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BatchTaskId | String | 批量预测任务ID 示例值:batch-78ugzrx2xxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 CreateBatchTask
批量预测示例请求
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchTask
<公共请求参数>
{
"BatchTaskName": "task-xx",
"ChargeType": "POSTPAID_BY_HOUR",
"ResourceGroupId": "trsg-c7xxxx",
"ResourceConfigInfo": {
"Role": "WORKER",
"Cpu": 1,
"Memory": 1,
"GpuType": "A",
"Gpu": 1,
"InstanceType": "TI.S.LARGE.POST-XXX",
"InstanceNum": 1
},
"Tags": [
{
"TagKey": "abc",
"TagValue": "def"
}
],
"ModelInfo": {
"ModelId": "abc-id",
"ModelName": "Pytorch",
"ModelVersionId": "mv-v2-abcdef",
"ModelVersion": "v2",
"ModelSource": "cos",
"CosPathInfo": {
"Bucket": "test-sh-123",
"Region": "ap-shanghai",
"Paths": [
"test/model"
]
},
"AlgorithmFramework": "torch",
"ModelType": "ACCELERATE"
},
"ImageInfo": {
"ImageType": "CCR",
"ImageUrl": "ccr.tencentyun.com/a/b/c",
"RegistryRegion": "",
"RegistryId": ""
},
"CodePackage": {
"Bucket": "testbkt-1234",
"Region": "ap-shanghai",
"Paths": [
"test/model/code_Path"
]
},
"StartCmd": "python3 /opt/ml/code/model_service.py",
"StartCmdBase64": "L2FwcC9ydW4uc2g=",
"DataConfigs": [
{
"MappingPath": "",
"DataSourceType": "",
"DataSetSource": {
"Id": "12345678"
},
"COSSource": {
"Bucket": "test-bkt-1234",
"Region": "ap-shanghai",
"Paths": [
"test/data/"
]
},
"CFSSource": {
"Id": "12345",
"Path": "/data"
},
"HDFSSource": {
"Id": "12345",
"Path": "test/hdfs_path/"
}
}
],
"Outputs": [
{
"MappingPath": "",
"DataSourceType": "cos",
"DataSetSource": {
"Id": "ds-12345-xx"
},
"COSSource": {
"Bucket": "testbkt-12345",
"Region": "ap-shanghai",
"Paths": [
"tests/outputs/"
]
},
"CFSSource": {
"Id": "",
"Path": ""
},
"HDFSSource": {
"Id": "",
"Path": ""
}
}
],
"LogEnable": true,
"LogConfig": {
"LogsetId": "123456",
"TopicId": "topic-12345"
},
"VpcId": "12345",
"SubnetId": "12345",
"Remark": "",
"CallbackUrl": ""
}
输出示例
{
"Response": {
"BatchTaskId": "task-123-xx",
"RequestId": "abcdef-1234"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.CamException | CAM系统异常。 |
FailedOperation | 操作失败。 |
FailedOperation.ExecTagFail | 标签操作失败。 |
FailedOperation.QueryTagFail | 查询标签服务失败。 |
FailedOperation.UnmarshalData | 数据解析失败。 |
InvalidParameter | 参数错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied.BalanceInsufficient | 余额不足,创建/更新失败。 |
OperationDenied.WhitelistQuotaExceed | 白名单免费配额不足。 |
UnauthorizedOperation | 未授权操作。 |