拉取上传

最近更新时间:2024-03-12 02:01:18

我的收藏

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)。
支持的扩展名详见媒体类型。请确保媒体 URL 可以访问。
示例值:http://www.abc.com/abc.mp4
MediaType String 媒体文件类型(扩展名),支持的类型详见媒体类型
如果 MediaType 不填或取值为空字符串,将根据 MediaUrl 自动获取文件类型。
示例值:mp4
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:123
MediaName String 媒体名称。
示例值:media.mp4
CoverUrl String 要拉取的视频封面 URL。支持的文件格式:gif、jpeg(jpg)、png。
示例值:xxx/cover.jpg
Procedure String 媒体后续任务操作,详见上传指定任务流
示例值:MyProcedure
ExpireTime Timestamp ISO8601 媒体文件过期时间,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
示例值:2020-09-07T00:00:00+08:00
StorageRegion String 指定上传园区,仅适用于对上传地域有特殊需求的用户:
  • 不填默认上传至您的默认地域
  • 若指定上传园区,请先确认上传存储设置已经开启相应的存储地域。

  • 示例值:ap-beijing
    ClassId Integer 分类ID,用于对媒体进行分类管理,可通过创建分类接口,创建分类,获得分类 ID。
    示例值:1
    SessionContext String 来源上下文,用于透传用户请求信息,当指定 Procedure 任务后,任务流状态变更回调将返回该字段值,最长 1000 个字符。
    示例值:123
    SessionId String 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
    示例值:123
    ExtInfo String 保留字段,特殊用途时使用。
    示例值:ExtInfo1
    SourceContext String 来源上下文,用于透传用户请求信息,上传完成回调 将返回该字段值,最长 250 个字符。
    示例值:123

    3. 输出参数

    参数名称 类型 描述
    TaskId String 拉取上传视频的任务 ID,可以通过该 ID 查询拉取上传任务的状态。
    示例值:125xxxxxx07-pull-893dc41e6fdc22dcf24aa6e9c61cp94
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 拉取上传一个 URL 为

    http://www.abc.com/abc.mp4

    的 MP4 视频。

    拉取上传 MP4 视频

    输入示例

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-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 视频至重庆园区。

    拉取上传 MP4 视频至重庆园区

    输入示例

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: PullUpload
    <公共请求参数>
    
    {
        "StorageRegion": "ap-chongqing",
        "MediaUrl": "http://www.abc.com/abc.mp4"
    }

    输出示例

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

    示例3 拉取上传一个海外 URL 为

    http://www.abc.com/abc.mp4

    的 MP4 视频至新加坡园区。

    拉取上传 MP4 至新加坡园区

    输入示例

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: PullUpload
    <公共请求参数>
    
    {
        "StorageRegion": "ap-singapore",
        "MediaUrl": "http://www.abc.com/abc.mp4"
    }

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

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