服务端 API 文档

拉取上传

最近更新时间:2020-07-16 08:21:17

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

该接口用于将一个网络上的视频拉取到云点播平台。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:PullUpload。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,本接口不需要传递此参数。
MediaUrl String 要拉取的媒体 URL,暂不支持拉取 Dash 格式(可以支持 HLS)。
支持的扩展名详见媒体类型
MediaName String 媒体名称。
CoverUrl String 要拉取的视频封面 URL。仅支持 gif、jpeg、png 三种图片格式。
Procedure String 媒体后续任务操作,详见上传指定任务流
ExpireTime Timestamp 媒体文件过期时间,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
StorageRegion String 指定上传园区,仅适用于对上传地域有特殊需求的用户(目前仅支持北京、上海和重庆园区)。
ClassId Integer 分类ID,用于对媒体进行分类管理,可通过创建分类接口,创建分类,获得分类 ID。
SessionContext String 来源上下文,用于透传用户请求信息,当指定 Procedure 任务后,任务流状态变更回调将返回该字段值,最长 1000 个字符。
SessionId String 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
ExtInfo String 保留字段,特殊用途时使用。
SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
SourceContext String 来源上下文,用于透传用户请求信息,上传完成回调 将返回该字段值,最长 250 个字符。

3. 输出参数

参数名称 类型 描述
TaskId String 拉取上传视频的任务 ID,可以通过该 ID 查询拉取上传任务的状态。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 拉取上传一个 URL 为 http://www.abc.com/abc.mp4 的 MP4 视频。

输入示例

https://vod.tencentcloudapi.com/?Action=PullUpload
&MediaUrl=http://www.abc.com/abc.mp4
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
    "TaskId": "125xxxxxx07-pull-893dc41e6fdc22dcf24aa6e9c61cp94"
  }
}

示例2 拉取上传一个国内 URL 为 http://www.abc.com/abc.mp4 的 MP4 视频至重庆园区。

输入示例

https://vod.tencentcloudapi.com/?Action=PullUpload
&MediaUrl=http://www.abc.com/abc.mp4
&StorageRegion=ap-chongqing
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
    "TaskId": "125xxxxxx07-pull-793dc41e6fdc22dcf24aa6e9c61cp94"
  }
}

示例3 拉取上传一个海外 URL 为 http://www.abc.com/abc.mp4 的 MP4 视频至新加坡园区。

输入示例

https://vod.tencentcloudapi.com/?Action=PullUpload
&MediaUrl=http://www.abc.com/abc.mp4
&StorageRegion=ap-singapore
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
    "TaskId": "125xxxxxx07-pull-693dc41e6fdc22dcf24aa6e9c61cp94"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.CoverType 操作失败:不支持的封面类型。
FailedOperation.MediaType 操作失败:不支持的媒体类型。
InternalError 内部错误。
InvalidParameter.ExpireTime 参数值错误:过期时间。
InvalidParameter.StorageRegion 参数值错误:存储地域。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.CoverUrl 参数值错误:封面 URL。
InvalidParameterValue.MediaUrl 参数值错误:媒体文件 URL。
InvalidParameterValue.SessionContextTooLong SessionContext 过长。
InvalidParameterValue.SessionId 去重识别码重复,请求被去重。
InvalidParameterValue.SessionIdTooLong SessionId 过长。
ResourceNotFound.CoverUrl 资源不存在:封面不存在。
ResourceNotFound.UserNotExist 用户不存在。
UnauthorizedOperation 未授权操作。
目录