开发指南

服务端 API 文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

1. 接口描述

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

  • 我们强烈建议您使用云点播提供的 服务端上传 SDK 来上传文件。直接调用 API 进行上传的难度和工作量都显著大于使用 SDK。
  • 该接口用于申请媒体文件(和封面文件)的上传,获取文件上传到云点播的元信息(包括上传路径、上传签名等),用于后续上传接口。
  • 上传流程请参考 服务端上传综述

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ApplyUpload。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,详见产品支持的 地域列表
MediaType String 媒体类型,可选值请参考 上传能力综述
SubAppId Integer 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
MediaName String 媒体名称。
CoverType String 封面类型,可选值请参考 上传能力综述
Procedure String 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。
ExpireTime Timestamp ISO8601 媒体文件过期时间,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
StorageRegion String 指定上传园区,仅适用于对上传地域有特殊需求的用户。
ClassId Integer 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
  • 默认值:0,表示其他分类。
  • SourceContext String 来源上下文,用于透传用户请求信息,上传完成回调 将返回该字段值,最长 250 个字符。
    SessionContext String 会话上下文,用于透传用户请求信息,当指定 Procedure 参数后,任务流状态变更回调 将返回该字段值,最长 1000 个字符。
    ExtInfo String 保留字段,特殊用途时使用。

    3. 输出参数

    参数名称 类型 描述
    StorageBucket String 存储桶,用于上传接口 URL 的 bucket_name。
    StorageRegion String 存储园区,用于上传接口 Host 的 Region。
    VodSessionKey String 点播会话,用于确认上传接口的参数 VodSessionKey。
    MediaStoragePath String 媒体存储路径,用于上传接口存储媒体的对象键(Key)。
    CoverStoragePath String 封面存储路径,用于上传接口存储封面的对象键(Key)。
    TempCertificate TempCertificate 临时凭证,用于上传接口的权限验证。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 申请上传成功例子

    输入示例

    https://vod.tencentcloudapi.com/?Action=ApplyUpload
    &MediaType=mp4
    &SubAppId=1
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "CoverStoragePath": null,
            "RequestId": "880f3005-a8c9-4bba-8c87-74e216a17a0b",
            "StorageBucket": "xadagzp111211-100922",
            "StorageRegion": "ap-guangzhou-2",
            "MediaStoragePath": "/dir/name.xx",
            "VodSessionKey": "VodSessionKey",
            "TempCertificate": {
                "SecretId": "xxxxxxx",
                "SecretKey": "xxxxxxxx",
                "Token": "xxxxxxxx",
                "ExpiredTime": 182823331
            }
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError 内部错误。
    InvalidParameter.ExpireTime 参数值错误:过期时间。
    InvalidParameterValue.CoverType 参数值错误:封面类型。
    InvalidParameterValue.ExpireTime 参数值错误:ExpireTime 格式错误。
    InvalidParameterValue.MediaType 参数值错误:媒体类型。
    InvalidParameterValue.SubAppId 参数值错误:子应用 ID。
    UnauthorizedOperation 未授权操作。
    目录