停止批量预测任务
更新时间：2024-12-23
接口描述
本接口用于根据任务ID停止批量预测任务。
权限说明
调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：
- 完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
- 运维操作千帆大模型平台预测服务的权限：QianfanServiceOperateAccessPolicy
鉴权说明
调用本文API，使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权，无法使用获取Access Token的方式鉴权，具体鉴权认证机制参考鉴权认证机制。
请求结构
POST /v2/batchinference?Action=StopBatchInferenceTask HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"taskId":"infer-9ia3***mp"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
- 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
}错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码，帮助理解和解决发生的错误 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如返回：
{
"requestId":"1bef3f87-xxx0f9884f10d4",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。