停止批量预测任务

更新时间：2024-09-04

功能介绍

本接口用于根据任务ID停止批量预测任务。

SDK调用

使用说明

本文API支持通过千帆Python SDK、Go SDK、Java SDK 和 Node.js SDK调用，调用流程请参考SDK安装及使用流程。

调用示例

import os
from qianfan  import resources


# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_access_key"
os.environ["QIANFAN_SECRET_KEY"] = "your_secret_key"


resp = resources.console.utils.call_action(
    "/v2/batchinference", "StopBatchInferenceTask", {"taskId": "infer-xxx"}
)
print(resp.body)

package main
import (
    "context"
    "fmt"
    "os"
    "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
     // 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
    os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
    os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
    
    ca := qianfan.NewConsoleAction()
    
    res, err := ca.Call(context.TODO(), "/v2/batchinference", "StopBatchInferenceTask", map[string]interface{}{
               "taskId":"infer-9ia3xxxt9mp",
    })
    if err != nil {
        panic(err)
    }
    fmt.Println(string(res.Body))
    
}

import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;

public class Dome {
    public static void main(String args[]){
        // 使用安全认证AK/SK鉴权，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
        Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
        
        ConsoleResponse<Map<String, Object>> response = qianfan.console()
                // 调用本文API，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求地址的后缀
                .route("/v2/batchinference")
                // 调用本文API，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求参数-Query参数的Action
                .action("StopBatchInferenceTask")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 对应本文HTTP调用-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
                .body(CollUtils.mapOf(
                    "taskId","infer-9ia3kc1wt9mp"
                ))
                .execute();

        System.out.println(Json.serialize(response));
    }
}

import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";

// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');

async function main() {
  const res = await consoleAction({base_api_route: 'v2/batchinference', action: 'StopBatchInferenceTask', data: {
        "taskId":"infer-9ia3kc1wt9mp"
    }
  });    
    
  console.log(res);
}

main();

返回示例

{
    'requestId':'1bef3f87-c5b2-4419-936b-50f9884f10d4',
    'result': True
}

{
    "requestId":"1bef3f87-c5b2-4419-936bxxxxf10d4",
    "result": true
}

{
    "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
    "result": true
}

{
    requestId:'1bef3f87-c5b2-4419-936b-50f9884f10d4',
    result: true
}

请求参数

请参考本文HTTP调用-请求说明。

响应参数

请参考本文HTTP调用-响应说明。

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：表示失败

请求示例

Bash

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"
}'

响应示例

JSON

{
    "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
    "result": true
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
requestId	请求ID
code	错误码，帮助理解和解决发生的错误
message	错误描述信息，帮助理解和解决发生的错误

例如返回：

{
    "requestId":"1bef3f87-xxx0f9884f10d4",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多千帆大模型平台其他错误码，也可以查看错误码说明。

获取批量预测任务列表

命令行CLI工具