跳到主要内容

视频文件任务关闭接口

1. 接口介绍​

业务流程需取消 未处理的视频文件任务 时，关闭视频文件任务。

2. 请求​

2.1 请求地址​

区域请求地址
国内https://api.video.tuputech.com/v3.1/recognition/video/close/<secretId>
国外https://api-oversea.video.tuputech.com/v3.1/recognition/video/close/<secretId>
提示

<secretId> 需替换为您的应用 SID，请联系客户经理为您开通及配置。关于 SID 详见 常见问题（FAQ）。

2.2 请求方法​

POST

2.3 请求头​

请求头名称取值是否必需示例说明
Content-Typeapplication/json是Content-Type: application/json请求数据类型为 JSON
X-API-Key<API Key>是X-API-Key: <API Key>API Key 用于接口鉴权。请访问控制台 - 数字证书 获取 API Key

2.4 超时时间及异常处理​

建议配置超时时间 1 秒，在 HTTP 响应状态码非 200 或业务状态码不为 0 时进行重试。

2.5 请求参数说明 🔥​

参数名称类型是否必填说明
requestIdString是任务 ID
timestampInt否当前服务器的 Unix 时间戳。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权
nonceFloat否随机数（建议使用 Unix 时间戳或若干位随机整数）。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权
signatureString否

RSA-SHA256 算法签名。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权。

签名步骤：

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名方式及示例

2.6 请求示例​

{
  "requestId": "<requestId>",
  "timestamp": 1685000000,
  "nonce": 1685000000,
  "signature": "<signature>"
}

3. 同步响应​

3.1 响应参数说明 🔥🔥​

参数名称类型说明
signatureString

同步响应或回调请求签名，由图普使用私钥签名，在需要时，您可以通过 图普公钥 进行验签以确保此响应内容来自图普（与您调用接口时使用的公私钥不同）。验签步骤：

  1. 取 json 字段内容为 SignString；
  2. 将 signature 字段内容进行 Base64 解码，得到 RawSignature；
  3. 使用图普公钥以 SHA256 算法验证 RawSignature 及 SignString
jsonString

同步响应或回调请求经过 JSON 转义后的字符串，需进一步解析得到业务数据。

  • 字段内容示例：{\"code\":0, \"message\":\"success\"}；
  • 字段详见下述 JSON 参数说明；
  • 为方便展示，同步响应及回调请求的示例中，均为解析后的 JSON

JSON 参数说明​

参数名称类型是否必有说明
codeInt是状态码，详见 业务状态码。

1. 若尝试关闭正在处理、已处理完成或失败的任务，会返回业务状态码 15，业务信息提示 task can not be terminated: specified task is running, finished or failed
messageString是返回信息
requestIdString是任务 ID
nonceFloat是随机数（建议使用 Unix 时间戳或若干位随机整数）
timestampInt是当前服务器的 Unix 时间戳

3.2 响应示例​

{
  "requestId": "<requestId>",
  "code": 0,
  "message": "success",
  "nonce": 1685000000,
  "timestamp": 1685000000
}
{
  "code": 15,
  "message": "参数错误：其他参数校验错误 (task can not be terminated: specified task is running, finished or failed)",
  "timestamp": 1685000000,
  "nonce": 1685000000,
  "signature": "<signature>"
}

4. 更新日志​

日期说明
2025-06-17新增 API Key 接口鉴权方式，简化接口鉴权。废弃签名鉴权方式，仅保持兼容（采用签名鉴权方式的调用不受影响）