1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
查询批量预测任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBatchTask。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
BatchTaskId | 是 | String | 批量预测任务ID 示例值:batch-78ugzrxxxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BatchTaskDetail | BatchTaskDetail | 批量预测任务详情 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询批量预测任务
查询单个批量预测任务详情
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchTask
<公共请求参数>
{
"BatchTaskId": "batch-78ugzrxxxxx"
}
输出示例
{
"Response": {
"BatchTaskDetail": {
"BatchTaskId": "batch-78ugzrxxxxx",
"BatchTaskName": "示例任务",
"Uin": "100011111111",
"SubUin": "100011111111",
"Region": "ap-shanghai",
"ChargeType": "PREPAID",
"ResourceGroupId": "ersg-l5pg11111",
"ResourceGroupName": "示例资源组",
"ResourceConfigInfo": {
"Role": "WORKER",
"Cpu": 4000,
"Memory": 8192,
"GpuType": "T4",
"Gpu": 0,
"InstanceType": "",
"InstanceTypeAlias": "",
"InstanceNum": 1,
"RDMAConfig": {
"Enable": true
}
},
"Tags": [],
"ModelInfo": {
"ModelId": "m-76225796131111111111",
"ModelName": "classify-cpu",
"ModelVersionId": "mv-v1-76225796131111111111",
"ModelVersion": "v1",
"ModelSource": "COS",
"ModelType": "NORMAL",
"CosPathInfo": {
"Bucket": "example-sh-125651111",
"Region": "ap-shanghai",
"Paths": [
"classify/classify/"
]
},
"AlgorithmFramework": "PYTORCH"
},
"ImageInfo": {
"ImageType": "PRESET",
"ImageUrl": "tione.tencentcloudcr.com/qcloud-ti-platform/ti-cloud-infer-pytorch-cpu:example-v1",
"RegistryRegion": "",
"RegistryId": ""
},
"CodePackagePath": {
"Bucket": "",
"Region": "",
"Paths": []
},
"StartCmd": "",
"DataConfigs": [
{
"MappingPath": "",
"DataSourceType": "COS",
"DataSetSource": null,
"COSSource": {
"Bucket": "example-test-sh-125658111111",
"Region": "ap-shanghai",
"Paths": [
"data/test/"
]
},
"CFSSource": null,
"HDFSSource": null,
"CFSTurboSource": null,
"GooseFSSource": null
}
],
"Outputs": [
{
"MappingPath": "",
"DataSourceType": "COS",
"DataSetSource": null,
"COSSource": {
"Bucket": "example-test-sh-125658111111",
"Region": "ap-shanghai",
"Paths": [
"output/"
]
},
"CFSSource": null,
"HDFSSource": null,
"GooseFSSource": null,
"CFSTurboSource": null
}
],
"LogEnable": false,
"LogConfig": {
"LogsetId": "",
"TopicId": ""
},
"VpcId": "",
"SubnetId": "",
"Status": "SUCCEED",
"RuntimeInSeconds": 89,
"CreateTime": "2023-12-26 20:15:41",
"UpdateTime": "2023-12-26 20:17:38",
"StartTime": "2023-12-26 20:16:07",
"EndTime": "2023-12-26 20:17:36",
"ChargeStatus": "NOT_BILLING",
"LatestInstanceId": "batch-78ugzrxxxxx-78ufl1m111w",
"Remark": "",
"FailureReason": "job succeed",
"BillingInfo": "",
"PodList": [],
"ModelInferenceCodeInfo": {
"Bucket": "example-test-sh-125658111111",
"Region": "ap-shanghai",
"Paths": [
"classify/classify/batch/model_service.py"
]
}
},
"RequestId": "2ec5cd1e-311b-1111-9119-3da111160111"
}
}
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系统异常。 |
AuthFailure.UnauthorizedOperation | 未授权操作。 |
FailedOperation | 操作失败。 |
FailedOperation.ExecTagFail | 标签操作失败。 |
FailedOperation.QueryTagFail | 查询标签服务失败。 |
FailedOperation.UnmarshalData | 数据解析失败。 |
InvalidParameter | 参数错误。 |
MissingParameter | 缺少参数错误。 |