获取上传地址和凭证--视频点播-火山引擎

文档中心

立即注册

导航

获取上传地址和凭证

最近更新时间：2022.09.16 18:12:44首次发布时间：2021.02.23 10:42:36

此接口用于获取媒资（视频/音频）上传地址和凭证，并创建视频信息。成功获取上传地址和凭证后，您还需要调用确认上传接口，完成上传。推荐使用服务端 SDK 进行上传。了解完整上传流程可参考媒资上传概述。

请求说明

接口名称：ApplyUploadInfo
请求地址：https://vod.volcengineapi.com/?Action=ApplyUploadInfo&Version=2020-08-01

请求参数

参数	类型	是否必选	描述
Action	String	是	接口名，取值： ApplyUploadInfo
Version	String	是	版本号：2020-08-01
SpaceName	String	是	空间名
SessionKey	String	否	上一次请求返回的会话 key，在重试时建议携带上，服务端会参考该值进行再次选路。
FileSize	Double	否	文件大小。
FileType	String	否	文件类型。默认为 media。上传音视频时无需传入。上传素材，可以根据素材实际类型选择取值如下所示。 media image object
FileName	String	否	文件路径。最大不超过 2048 字节。您可根据业务需求自定义文件路径。说明目前文件路径不支持 “/” 开头、空格、“+” 字符、"?" 字符和 "$" 字符。如果要使用此字段，请联系技术支持配置白名单。

返回参数

参数	类型	描述
ResponseMetaData	ResponseMetaData	响应通用信息
Result	Data	响应结果

ResponseMetadata

参数	类型	描述
RequestId	String	请求 ID
Action	String	请求接口
Version	String	版本
Service	String	服务
Region	String	区域
Error	ResponseError	异常信息

ResponseError

参数	类型	描述
Code	String	错误码
Message	String	详细错误信息

Data

参数	类型	描述
UploadAddress	UploadAddress	上传信息

UploadAddress

参数	类型	描述
StoreInfos	Array of StoreInfo	上传的信息
UploadHosts	Array of String	上传域名列表，可以用于客户端容灾，并行上传等
UploadHeader	Array of HeaderPair	分片上传时，http header
SessionKey	String	一次上传会话 key，上传完成上报时使用该值，类似于 http 协议的 cookie 机制

StoreInfo

参数	类型	描述
StoreUri	String	文件存放位置
Auth	String	上传凭证

HeaderPair

参数	类型	描述
Key	String	上传时 Header 需要携带的 Header Key
Value	String	上传时 Header 需要携带的 Header Value

示例

请求示例

https://vod.volcengineapi.com/?Action=ApplyUploadInfo&Version=2020-08-01&SpaceName=yourSpaceName

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20201105******920590B0006DE",
        "Action": "ApplyUploadInfo",
        "Version": "2020-08-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": {
            "UploadAddress": {
                "StoreInfos": [
                    {
                        "StoreUri": "tos-path-v-da1421/2e5dfd1f0c30****",
                        "Auth": "SWT46ONWN9J0DOFEOC5X:rzwrw4zJY345QfiS7F****"
                    }
                ],
                "UploadHosts": [
                    "vod.volcengineapi.com"
                ],
                "UploadHeader": {},
                "SessionKey": "eyJleHRyYSI6InZpZGM9Ym9lXHUwMDI2dnRzPTE2MD****"
            }
        }
    }
}

错误码

下表列举了本接口特有的错误码。视频点播公共错误码，详见公共错误码。

错误码	说明
InvalidParameter.InvalidAccessKeyError	AK错误
InvalidParameter.InvalidParamError	参数错误，包括 Session 的各个部分错误
InvalidParameter.UserNotSupportTosError	账号配置错误
RequestLimitExceeded.TooManyRequestError	请求超过上限
InvalidParameter.InvalidSpaceError	Space 填写错误
ResourceNotFound.VideoNotFoundError	未找到对应视频
InvalidParameter.InvalidTopAccountError	账号无权限
InternalError.SaveDBError	内部错误
InternalError.RunFunctionError	内部错误，执行 Function 时失败
InternalError.GetSignError	内部错误，获取上传地址签名失败
InternalError.RunPluginError	内部错误，运行插件失败
InternalError.InternalError	内部错误

SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：