GetURLUploadInfos - 获取URL上传信息

更新时间:
复制为 MD 格式

获取URL上传信息。

接口说明

  • 通过 URL 上传时返回的 JobId 或者上传时使用的 URL 来获取 URL 上传信息,包括 URL 上传状态、UserData、创建时间、完成时间等。

  • 本接口仅支持查询一年内的上传任务数据。

  • 本接口目前服务地址仅支持:华东 2(上海)、新加坡

  • 调用 UploadMediaByURL 接口将媒资文件上传到视频点播中后,可调用本接口通过 URL 拉取上传任务 ID(JobIds)或者媒体源文件 URL(UploadURLs)来查询指定媒体文件的上传信息。

  • 调用本接口时,JobIdsUploadURLs必须传入一个,二者同时传入时只处理JobIds

  • 如果媒资上传失败,调用本接口可以查看错误码和错误信息;如果媒资上传成功,调用本接口可以查看对应的媒资 ID。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vod:GetURLUploadInfos

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

JobIds

string

上传任务 ID(JobId)列表。由一个或多个 JobId 组成,JobId 为通过 UploadMediaByURL 接口上传时,返回参数 JobId 的值。

  • 最多支持 10 个 ID。

  • 多个 ID 之间使用半角逗号(,)分隔。

说明

JobIds 和 UploadURLs 必须指定一个,二者同时传入时只处理 JobIds。

86c1925fba0****,7afb201e7fa****,2cc4997378****

UploadURLs

string

上传视频源文件 URL 列表。多个 URL 之间使用半角逗号(,)分隔,最多支持 10 个。

说明
  • 使用前,先进行 URL 编码。

  • 如果同一 URL 视频多次上传,建议传入单个 URL 进行查询。

  • JobIds 和 UploadURLs 必须指定一个,二者同时传入时只处理 JobIds。

http://****.mp4

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

25818875-5F78-4AF6-D7393642CA58****

NonExists

array

不存在的 URL 上传任务 ID 或 URL 列表。

string

不存在的 URL 上传任务 ID 或 URL 列表。

["****1", "****2"]

URLUploadInfoList

array<object>

URL 上传信息列表。具体上传名称及描述,请参见URLUploadInfo:URL 上传信息

object

URL 上传信息详情。

CreationTime

string

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

2019-01-01T01:01:01Z

Status

string

URL 拉取任务状态。具体的拉取状态取值及说明,请参见Status:URL 上传任务状态

SUCCESS

ErrorMessage

string

错误信息。

error_message

ErrorCode

string

错误码。

200

CompleteTime

string

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

2019-01-01T01:11:01Z

JobId

string

上传任务 ID。

86c1925fba0****

UserData

string

自定义设置。为 JSON 字符串。更多信息,请参见 UserData

{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}

UploadURL

string

上传视频源文件 URL。

说明

最多可以返回 100 条记录。

http://****.mp4

MediaId

string

媒体 ID。

93ab850b4f6f54b6e91d24d81d4****

FileSize

string

文件大小。单位:字节。

24

RegisteredMediaId

string

93ab850b4f654b6e91d24d81d44****

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "NonExists": [
    "[\"****1\", \"****2\"]"
  ],
  "URLUploadInfoList": [
    {
      "CreationTime": "2019-01-01T01:01:01Z",
      "Status": "SUCCESS",
      "ErrorMessage": "error_message",
      "ErrorCode": "200",
      "CompleteTime": "2019-01-01T01:11:01Z",
      "JobId": "86c1925fba0****",
      "UserData": "{\"MessageCallback\":\"{\"CallbackURL\":\"http://example.aliyundoc.com\"}\", \"Extend\":\"{\"localId\":\"***\", \"test\":\"www\"}\"}",
      "UploadURL": "http://****.mp4",
      "MediaId": "93ab850b4f6f54b6e91d24d81d4****",
      "FileSize": "24",
      "RegisteredMediaId": "93ab850b4f654b6e91d24d81d44****"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情