logo
控制台登录/注册
文档
服务端 API
云端播放器
API 概览
调用方法
在线调试服务端 API
POST
创建云端播放器
POST
更新云端播放器
POST
销毁云端播放器
POST
查询云端播放器列表
POST
创建上传任务
POST
取消上传任务
POST
查询上传任务
回调说明
全局返回码
当前页

DescribeUploadTasks

POST

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

本接口可用于获取单个或多个上传任务的详情。

说明
  • 若下列参数都不传，则表示查询所有上传任务的详细信息，返回结果包含至多 50 个任务的详细信息。
  • 若仅传入 UploadTaskId，表示查询对应上传任务的详细信息。
  • 当同时传入 UploadTaskId 和 Status 时，若 Status 不符合该上传任务的实际状态，则返回结果为空。
说明
调用频率限制：20 次/秒

Request

Query Parameters

    Action string必填

    可选值: [DescribeUploadTasks]

    接口原型参数

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

    AppId uint32必填

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

    SignatureNonce string必填

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

    Timestamp int64必填

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

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

    Signature string必填

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

Body

    UploadTaskId string

    待查询的上传任务 ID。当传入此参数时，PageSize 无效。

    Status number

    可选值: [0, 1, 2, 3, 4, 5, 6, 7]

    查询处于特定状态的上传任务。支持下列值：

    • 0：默认值，无意义。
    • 1：等待中。
    • 2：上传中。
    • 3：等待重试。
    • 4：上传成功。
    • 5：上传失败。
    • 6：已取消。
    • 7：已过期。
    PageSize number

    当前请求返回的数据量上限。取值范围为 (0, 50]，为空时默认为 50。

    PageToken string

    分页拉取标志。

    第一次查询无需设置此参数。当返回参数中 NextPageToken 不为空时，表示之后的查询结果未获取完毕，再次调用本接口继续查询时，此参数填写该 NextPageToken 的值。

Responses​

OK
Schema
    Code number

    返回码。

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

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

    操作结果描述。

    RequestId string

    请求 ID。

    Data object
    返回的具体信息。
    TotalSize number

    查询结果总数。

    NextPageToken string

    分页拉取标志。

    • 非空时表示还有未返回的结果信息，需要将此值设置到请求参数的 PageToken 中再次调用本接口获取剩余结果信息。
    • 为空时表示已经返回所有结果信息。

    说明

    除上述说明之外，此字段与列表信息无任何关联，请勿基于此做任何其他逻辑。

    UploadTasks object[]
    查询结果详情。
  • Array[
    • UploadTaskId string

    上传任务 ID。

    StreamUrl string

    媒体资源的地址。

    Title string

    文件标题。

    Status number

    可选值: [1, 2, 3, 4, 5, 6, 7]

    上传状态，数值如下所示：

    • 1：等待中
    • 2：上传中
    • 3：等待重试
    • 4：上传成功
    • 5：上传失败
    • 6：已取消
    • 7：已过期
    RetryCount number

    上传重试次数。

    ExpiresAt number

    文件的过期 Unix 时间戳，单位为秒。

    CreateTime number

    上传任务创建成功的 Unix 时间戳，单位为秒。

    UploadStreamUrl string

    上传成功后，文件的公网 URL。

    InternalUploadStreamUrl string

    上传成功后，文件的 ZEGO 内网 URL。

    说明

    建议在 创建媒体播放器 时用作 StreamUrl。

  • ]

上一篇

取消上传任务

下一篇

回调配置说明

当前页

返回到顶部