停止任务运行
更新时间:2024-09-23
注意:为提升开发者使用体验,平台升级了模型调优接口。推荐使用新版模型精调接口,功能更全面、且接口更规范,详见模型调优API列表;V1版本相关接口不再升级,已于2024年9月8日将本文档迁移至历史文档;由于V1版本接口后续可能下线停止服务,为避免影响使用,建议接入新版本接口。
功能介绍
本接口用于停止训练任务运行。
注意事项
本文接口能力不再升级,如果之前已接入使用,可继续使用;推荐使用模型精调V2版本。
SDK调用
使用说明
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
import os
from qianfan import resources
# 使用安全认证AK/SK鉴权,通过环境变量方式初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
stop = resources.FineTune.stop_job(10250, 6205)
返回示例
QfResponse(code=200, headers={
...
},
body={'log_id': '35535401111', 'result': True},
)
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
task_id | int | 是 | 任务ID |
job_id | int | 是 | 运行ID |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 请求ID |
result | bool | 请求结果 |
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址: https://qianfan.baidubce.com/wenxinworkshop/finetune/stopJob
请求方式: POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
x-bce-date | string | 否 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
taskId | int | 是 | 任务ID |
jobId | int | 是 | 运行ID |
响应说明
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 请求ID |
result | bool | 请求结果 |
请求示例
# 替换下列示例中的Authorization、x-bce-date、taskId、jobId
curl --location 'https://qianfan.baidubce.com/wenxinworkshop/finetune/stopJob' \
--header 'Authorization: bce-auth-v1/f0ee7a16xxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8xxxxx' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"taskId": 7263,
"jobId": 4612
}'
响应示例
{
"log_id": "123",
"result": true
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如参数错误返回:
{
"error_code": 500001,
"error_msg": "param invalid"
}
更多其他错误码,也可以查看错误码说明。