最近更新时间:2024.03.28 20:49:48
首次发布时间:2021.02.23 10:42:38
此接口用于通过源文件 URL,拉取媒体文件并上传到视频点播,支持批量操作。
URL 限制:URL 必须是源文件 URL,不是包含视频文件的页面 URL 等。URL 支持 HTTP/HTTPS。
请求地址:https://vod.volcengineapi.com?Action=UploadMediaByUrl&Version=2020-08-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UploadMediaByUrl | 接口名称。当前 API 的名称为 UploadMediaByUrl 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
SpaceName | String | 是 |
| 点播空间名称。可通过以下方式获取空间名称: |
URLSets | String | 是 | [{"SourceUrl":"https://demourl","TemplateId":"25524a2dae45***b2e891d7daf4b9","Title":"demo","ClassificationId":6708,"StorageClass":1,"FileName":"example","FileExtension":".m3u8"}] | URL 及其对应配置,限制 20 条。为 URLSet 数组的 JSON 字符串。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
SourceUrl | String | 是 | https://demourl | 源视频 URL。 |
CallbackArgs | String | 否 | YourCallbackArgs | 用户额外信息。回调时会透传返回,最大长度 512 字节。 |
Md5 | String | 否 | b9fd116504b***88e59a824878f07a | 文件的 Md5 值。Md5 不为空时,视频点播服务端会计算文件的 Md5,与传入的 Md5 做对比,不一致会报错。 |
TemplateId | String | 否 | 25524a2dae45***b2e891d7daf4b9 | 工作流 ID。上传完成后如果希望自动触发工作流,可填写工作流 ID 字段。 |
Title | String | 否 | demo | 文件标题。不超过 512 个字符。 |
Description | String | 否 | 视频测试 | 文件描述。不超过 256 个字符。 |
Tags | String | 否 | tag1 | 文件标签。多个以 , 分隔,不超过 36 个字符。 |
Category | String | 否 |
| 分类 ID。可通过以下方式获取:
|
FileName | String | 否 |
| 文件路径,即文件在点播存储中的存储位置,等同于传统对象存储的对象键(ObjectKey)概念。您可根据业务需求自定义文件路径。最大不超过 1024 个字符。 说明
|
ClassificationId | Long | 否 |
| 分类 ID。可通过以下方式获取:
注意 素材不支持分类。 |
StorageClass | Integer | 否 |
| 存储类型。默认为
|
FileExtension | String | 否 |
| 文件后缀,即点播存储中文件的类型。 说明
|
UrlEncryptionAlgorithm | String | 否 |
| 源 URL 加密方法。目前支持的取值为 说明 加密方法必须与文件后缀共同传入, |
EnableLowPriority | Boolean | 否 |
| 是否开启闲时转码功能。取值如下:
说明 对于闲时转码能力的介绍和使用场景,请见闲时转码。 |
CustomURLHeaders | JSON Map | 否 |
| 自定义携带 URL Header。格式为
|
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array of ValuePair | - | URL 和对应 JobId 的结构数组。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SourceUrl | String | https://demourl.mp4 | 源视频 URL。 |
JobId | String | db3ab211095******b0955a30b550 | URL 对应的 ID,可查询上传状态。 |
https://vod.volcengineapi.com?Action=UploadMediaByUrl&Version=2020-08-01&SpaceName=YourSpaceName
{ "ResponseMetadata": { "RequestId": "20201102******2250910621303DE51", "Action": "UploadVideoByUrl", "Version": "2022-12-01", "Service": "vod", "Region": "cn-north-1" }, "Result": { "Data": [ { "JobId": "db3ab211095******b0955a30b550", "SourceUrl": "https://demourl.mp4" } ] } }
下表列举了本接口特有的错误码。视频点播公共错误码,详见公共错误码。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.UploadParamsError |
| |
400 | InvalidParameter.AKMissMatchError | - | 参数错误,账号无权限。 |
500 | InternalError.QueryBodyError | - | 内部错误,查询 JobId 失败。 |
400 | InvalidParameter.JobIdEmptyError | - | 参数错误,JobIds 字段为空。 |
400 | InvalidParameter.TitleLengthError | - | 参数错误,Title 字段超过 128个字符。 |
400 | InvalidParameter.DescriptionLengthError | - | 参数错误,Description 字段超过 256个字符。 |
400 | InvalidParameter.CategoryLengthError | - | 参数错误,Category 字段超过 256个字符。 |
400 | InvalidParameter.TagsLengthError | - | 参数错误,Tags 字段超过 36个字符。 |
400 | InvalidParameter.BodyParseError | - | 参数错误,传入的参数格式错误。 |
500 | InternalError.CreateUploadStateError | - | 内部错误,创建 URL 上传记录失败。 |
500 | InternalError.BuildRavenDataError | - | 内部错误,创建内部消息失败。 |
500 | InternalError.NsqSendError | - | 内部错误,发送消息失败。 |
500 | InternalError.GetAccountError | - | 内部错误,获取账号信息失败。 |
400 | InvalidParameter.SpaceNotExistsError | - | 参数错误,空间不存在。 |
403 | RequestForbidden.AccessIsRestricted | - | 账号访问受到限制。 |
400 | InvalidParameter.InvalidFileExtensionStyle | - | 文件后缀格式错误。 |
点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API,此 API 各语言调用的示例代码,请参考如下: