CancelUploadTask

POST

https://cloud-player-api.zego.im/

可通过本接口取消一个上传任务。

说明

本接口只能取消正在等待中的任务，不适用于已开始或已结束的任务。
取消结果请通过回调或查询上传任务接口判断。

说明

调用频率限制：20 次/秒

Request

Query Parameters

Action string必填

可选值: [CancelUploadTask]

接口原型参数

https://cloud-player-api.zego.im?Action=CancelUploadTask

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

UploadTaskId string必填

上传任务 ID，上传任务的唯一标识。在调用 CreateUploadTask 接口创建上传任务后，您可通过响应参数获取此 ID。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code number

错误码。

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
0	成功。	-
100000004	签名过期。	请重新生成签名。
100000005	签名错误。	请确认生成签名的参数是否正确。
350006001	接口请求频率超过上限。	请确认对应接口的 QPS 限制，降低请求频率。
350006002	网关校验失败。	请联系 ZEGO 技术支持处理。
350006003	无效的输入参数。	请根据 Message 提示，调整对应参数的取值。
350006006	服务未开通。	请联系 ZEGO 技术支持，开通服务权限。
350010000	系统错误。	请联系 ZEGO 技术支持处理。

Message string

错误描述。

RequestId string

请求 ID。

Data null

返回的具体信息。

{
  "Code": 0,
  "Message": "succeed",
  "RequestId": "3433376152562619",
  "Data": null
}

{
  "Code": 0,
  "Message": "succeed",
  "RequestId": "3433376152562619",
  "Data": null
}