You need to enable JavaScript to run this app.
导航

URL 批量拉取上传

最近更新时间2024.02.01 15:03:14

首次发布时间2021.02.23 10:42:38

此接口用于通过源文件 URL,拉取媒体文件并上传到视频点播,支持批量操作。

使用说明

  • 提交成功后,将会生成异步执行的任务,进行排队执行。
  • 提交任务后,您可通过以下方式获取 URL 批量拉取上传任务相关信息:
    • 通过 QueryUploadTaskInfo 接口查询 URL 批量上传任务状态。
    • 配置 URL 批量拉取上传完成回调通知,开启后每条 URL 上传完成您都将收到回调消息,详见回调设置

注意事项

URL 限制:URL 必须是源文件 URL,不是包含视频文件的页面 URL 等。URL 支持 HTTP/HTTPS。

请求说明

请求地址:https://vod.volcengineapi.com?Action=UploadMediaByUrl&Version=2020-08-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

参数类型是否必选示例值描述
ActionStringUploadMediaByUrl接口名称。当前 API 的名称为 UploadMediaByUrl
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

SpaceName

String

test

点播空间名称。可通过以下方式获取空间名称:

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
URLSetsString[{"SourceUrl":"https://demourl","TemplateId":"25524a2dae45***b2e891d7daf4b9","Title":"demo","ClassificationId":6708,"StorageClass":1,"FileName":"example","FileExtension":".m3u8"}]URL 及其对应配置,限制 20 条。为 URLSet 数组的 JSON 字符串。

URLSets

参数类型是否必选示例值描述
SourceUrlStringhttps://demourl源视频 URL。
CallbackArgsStringYourCallbackArgs用户额外信息。回调时会透传返回,最大长度 512 字节。
Md5Stringb9fd116504b***88e59a824878f07a文件的 Md5 值。Md5 不为空时,视频点播服务端会计算文件的 Md5,与传入的 Md5 做对比,不一致会报错。
TemplateIdString25524a2dae45***b2e891d7daf4b9工作流 ID。上传完成后如果希望自动触发工作流,可填写工作流 ID 字段。
TitleStringdemo文件标题。不超过 128 个字符。
DescriptionString视频测试文件描述。不超过 256 个字符。
TagsStringtag1文件标签。多个以 , 分隔,不超过 36 个字符。

Category

String

6708

分类 ID。可通过以下方式获取:

  • 在控制台系统设置 > 分类管理中查看。
  • 通过 ListVideoClassifications 接口查询指定空间下的分类 ID。

FileName

String

example.mp4

文件路径,即文件在点播存储中的存储位置,等同于传统对象存储的对象键(ObjectKey)概念。您可根据业务需求自定义文件路径。最大不超过 1024 个字符。

说明

  • 视频点播中,文件路径必须携带文件后缀,例如 .mp4。不强制要求携带文件前缀。
  • 具体的字符规则,请见文件命名通用字符规则
  • 设置 FileName 后, 当 FileName 相同时,有文件覆盖的风险。您需确保不同文件的 FileName 不同。
  • 传入 FileName 后,不需要再传入 FileExtension 参数。

ClassificationId

Long

6708

分类 ID。可通过以下方式获取:

  • 在控制台系统设置 > 分类管理中查看。
  • 通过媒资分类接口查询。

注意

素材不支持分类。

StorageClass

Integer

1

存储类型。默认为 1。取值如下:

  • 1:标准存储。
  • 2:归档存储。
  • 3:低频存储。

FileExtension

String

.m3u8

文件后缀,即点播存储中文件的类型。

说明

  • 文件后缀必须以 . 开头,不超过 8 位。
  • 当您传入 FileExtension 时,不需要重复传入 FileName 参数。视频点播将生成 32 位随机字符串,和您传入的 FileExtension 共同拼接成文件路径。

UrlEncryptionAlgorithm

String

DES

源 URL 加密方法。目前支持的取值为 DES,表示 PCKS5Padding 加密。

说明

加密方法必须与文件后缀共同传入,FileName 中带后缀或者 FileExtension 传入后缀。

EnableLowPriority

Boolean

false

是否开启闲时转码功能。取值如下:

  • true:开启。
  • false:(默认)关闭。

说明

对于闲时转码能力的介绍和使用场景,请见闲时转码

CustomURLHeaders

JSON Map

User-Agent:Mozilla/4.0

自定义携带 URL Header。格式为 "key":"value"

  • "key": String 类型,访问源视频 URL 携带的 HTTP Header 的 key。例如,User-Agent
  • "value": String 类型,访问源视频 URL 携带的 HTTP Header 的 value。例如,Mozilla/4.0

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
DataArray of ValuePair-URL 和对应 JobId 的结构数组。

ValuePair

参数类型示例值描述
SourceUrlStringhttps://demourl.mp4源视频 URL。
JobIdStringdb3ab211095******b0955a30b550URL 对应的 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

  • 必须字段错误,可以根据提示信息判断参数为空的具体字段。
  • 参数类型错误,可以根据提示信息判断参数类型是否正确。
400InvalidParameter.AKMissMatchError-参数错误,账号无权限。
500InternalError.QueryBodyError-内部错误,查询 JobId 失败。
400InvalidParameter.JobIdEmptyError-参数错误,JobIds 字段为空。
400InvalidParameter.TitleLengthError-参数错误,Title 字段超过 128个字符。
400InvalidParameter.DescriptionLengthError-参数错误,Description 字段超过 256个字符。
400InvalidParameter.CategoryLengthError-参数错误,Category 字段超过 256个字符。
400InvalidParameter.TagsLengthError-参数错误,Tags 字段超过 36个字符。
400InvalidParameter.BodyParseError-参数错误,传入的参数格式错误。
500InternalError.CreateUploadStateError-内部错误,创建 URL 上传记录失败。
500InternalError.BuildRavenDataError-内部错误,创建内部消息失败。
500InternalError.NsqSendError-内部错误,发送消息失败。
500InternalError.GetAccountError-内部错误,获取账号信息失败。
400InvalidParameter.SpaceNotExistsError-参数错误,空间不存在。
403RequestForbidden.AccessIsRestricted-账号访问受到限制。
400InvalidParameter.InvalidFileExtensionStyle-文件后缀格式错误。

服务端 SDK

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