全部产品
Search
文档中心

视频点播:GetUploadDetails - 获取媒体上传详情

更新时间:Jul 19, 2024

通过媒体ID获取媒体上传详情(如上传时间、已上传比例、上传来源等信息),支持批量获取。

接口说明

  • 本接口只支持获取音/视频的上传详情。
  • 如果通过点播控制台上传的音/视频,通过本接口可获取到上传比例等信息。如果是使用 SDK 上传的音/视频,满足以下条件的上传 SDK才能通过本接口获取到媒体上传详情。
说明 仅服务端上传 SDK 支持本接口,客户端上传 SDK 暂不支持本接口。本接口支持的服务端上传 SDK 版本限制如下:
  • Java 上传 SDK 的版本 ≥ 1.4.4
  • C++上传 SDK 的版本 ≥ 1.0.0
  • PHP 上传 SDK 的版本 ≥ 1.0.2
  • Python 上传 SDK 的版本 ≥ 1.3.0
  • QPS 限制

    本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

    调试

    您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

    • 操作:是指具体的权限点。
    • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
    • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
      • 对于必选的资源类型,用背景高亮的方式表示。
      • 对于不支持资源级授权的操作,用全部资源表示。
    • 条件关键字:是指云产品自身定义的条件关键字。
    • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    vod:GetUploadDetailsList
    • 全部资源
      *

    请求参数

    名称类型必填描述示例值
    MediaIdsstring

    媒体 ID,即音/视频 ID(VideoId)。多个 ID 之间使用半角逗号(,)分隔,最多支持 20 个。可通过以下方式获取:

    61ccbdb06fa83012be4d8083f6****,7d2fbc380b0e08e55f****
    MediaTypestring

    媒体类型。取固定值:video(音/视频)。

    video

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    9E290613-04F4-47F4-795D30732077****
    ForbiddenMediaIdsarray

    禁止访问的媒体 ID。

    string

    禁止访问的媒体 ID。

    7d2fbc380b0e08e55f****
    NonExistMediaIdsarray

    不存在的媒体 ID。

    string

    不存在的媒体 ID。

    dfsg****
    UploadDetailsarray<object>

    上传详情列表。

    object

    返回结果详情。

    Statusstring

    视频状态。具体的视频状态取值及描述,请参见Status:视频状态的取值列表。

    Uploading
    CreationTimestring

    创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2019-04-28T09:42:07Z
    UploadSourcestring

    上传资源。

    WebSDK
    UploadIPstring

    上传 IP 地址。

    192.168.0.1
    DeviceModelstring

    设备模型。

    Chrome
    ModificationTimestring

    更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2019-04-28T09:43:12Z
    CompletionTimestring

    完成时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2019-04-28T09:45:07Z
    MediaIdstring

    上传的音/视频 ID。

    61ccbdb06fa83012be4d8083f6****
    UploadSizelong

    上传大小。单位:字节。

    346
    UploadRatiofloat

    上传比率。

    0.038
    UploadStatusstring

    上传任务状态。具体的上传状态取值及描述,请参见Status:URL 上传任务状态的取值列表。

    Uploading
    Titlestring

    标题。

    测试文件上传详情
    FileSizelong

    文件大小。单位:字节。

    46

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "9E290613-04F4-47F4-795D30732077****",
      "ForbiddenMediaIds": [
        "7d2fbc380b0e08e55f****"
      ],
      "NonExistMediaIds": [
        "dfsg****"
      ],
      "UploadDetails": [
        {
          "Status": "Uploading",
          "CreationTime": "2019-04-28T09:42:07Z",
          "UploadSource": "WebSDK",
          "UploadIP": "192.168.0.1",
          "DeviceModel": "Chrome",
          "ModificationTime": "2019-04-28T09:43:12Z",
          "CompletionTime": "2019-04-28T09:45:07Z",
          "MediaId": "61ccbdb06fa83012be4d8083f6****",
          "UploadSize": 346,
          "UploadRatio": 0.038,
          "UploadStatus": "Uploading",
          "Title": "测试文件上传详情",
          "FileSize": 46
        }
      ]
    }

    错误码

    访问错误中心查看更多错误码。

    接口错误码

    下表列举了本接口特有的错误码。

    错误代码错误信息HTTP 状态码说明
    LimitExceeded.MediaIdsThe input parameter “MediaIds” Exceed the limit.400媒资 ID 数量超过上限 20 个。