停止批量预测任务
更新时间：2024-11-08
功能介绍
本接口用于根据任务ID停止批量预测任务。
权限说明
调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：
- 管理员权限：QianfanFullControlAccessPolicy
- 模型服务运维权限：QianfanServiceOperateAccessPolicy
HTTP调用
鉴权说明
调用本文API，使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权，无法使用获取Access Token的方式鉴权，具体鉴权认证机制参考鉴权认证机制。
请求说明
- 基本信息
请求地址： https://qianfan.baidubce.com/v2/batchinference
请求方式： POST
- Header参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值application/json |
| x-bce-date | string | 否 | 当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z |
| Authorization | string | 是 | 用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具 |
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值StopBatchInferenceTask |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| taskId | string | 是 | 任务ID，说明：只能通过调用创建批量预测任务接口，返回的字段taskId获取 |
响应说明
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| result | bool | 请求结果，说明： · true：表示成功 · false：表示失败 |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/batchinference?Action=StopBatchInferenceTask' \
--header 'Authorization: bce-auth-v1/f0ee7a166b934fxxx079702c13/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21axxxx16e374525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"taskId":"infer-9ia3kc1wt9mp"
}'响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": true
}SDK调用
平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考停止批量预测任务。
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码，帮助理解和解决发生的错误 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如返回：
{
"requestId":"1bef3f87-xxx0f9884f10d4",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。