调用 UpdateUploadSpaceConfig
接口更新空间上传配置,实现自动生成封面、自动转码等功能。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateUploadSpaceConfig | 接口名称。当前 API 的名称为 UpdateUploadSpaceConfig 。 |
Version | String | 是 | 2023-07-01 | 接口版本。当前 API 的版本为 2023-07-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
SpaceName | String | 是 | docspace | 点播空间名。 |
AutoPoster | String | 否 | enabled | 是否开启自动生成封面。默认关闭。开启后,视频上传成功时,系统自动选取首张非黑帧(黑帧标准:黑色元素占比超 80%)作为封面。取值如下:
说明 完整使用流程,请见设置视频封面。 |
CustomPosterConfig | Object | 否 | - | 自定义封面配置。仅当 AutoPoster 为 enabled 时生效。 |
CustomTemplateStatus | String | 是 | enabled | 是否开启自定义封面配置。默认关闭。开启后,您需设置
|
PathTemplate | String | 是 | abc.jpeg | 自定义生成的封面图文件路径。您可以输入固定字符串和变量。详情规则请参见自定义媒体处理输出文件路径。 注意
|
GetPosterMode | String | 否 | sync | 封面提取方式:
|
AutoTranscode | String | 否 | disabled | 是否开启自动触发工作流。默认关闭。取值如下:
|
TranscodeConfig | Object | 否 | - | 转码配置。仅当 AutoTranscode 为 enabled 时生效。 |
DefaultTemplateStatus | String | 是 | enabled | 是否开启自定义转码配置。默认关闭。开启后,您需设置
|
DefaultTemplateId | String | 是 | e89f4d08d1b94e208aa5bbb7db285dbd | 工作流 ID。您可在视频点播控制台创建工作流并获取工作流 ID,详见工作流。 |
AutoSetVideoStatus | String | 否 | published | 自动设置视频状态。在视频点播中,音视频资源的发布状态分为发布和未发布。默认情况下,上传到视频点播的音视频为未发布状态,无法获取播放地址进行播放。因此,在播放音视频之前,您必须将音视频的发布状态修改为已发布。取值如下:
|
UploadOverwrite | String | 否 | disabled | 是否开启覆盖上传。默认关闭。开启后,上传具有相同文件路径的新媒资文件时,会替换之前上传的旧媒资文件。取值如下:
注意 覆盖上传可能导致图床安全风险,如果没有适当的安全措施和权限管理,可能被攻击者滥用为注入恶意内容或删除重要文件的方式,请谨慎评估后开启。 |
CallbackReturnPlayUrl | String | 否 | enabled | 上传完成回调是否返回媒资播放地址。默认关闭。开启后,媒资上传完成事件中会返回视频播放地址。取值如下:
注意 您还需将 |
CallbackReturnRunId | String | 否 | disabled | 上传完成回调是否返回工作流任务 ID。默认关闭。开启后,如果您在上传音视频时触发工作流任务,媒资上传完成事件中会返回工作流任务 ID。取值如下:
|
GetMetaMode | String | 否 | default | 视频元信息提取方式。对于上传到视频点播、标准存储的音视频资源,视频点播默认会提取视频分辨率、时长、码率等元信息。取值如下:
|
AutoGetArchiveVideoMeta | String | 否 | disabled | 归档存储的媒资是否自动提取视频元信息。默认关闭。取值如下:
说明 对归档存储文件开启此功能会产生归档数据取回费用。详见归档存储计费。 |
AutoGetIAVideoMeta | String | 否 | disabled | 低频存储的媒资是否自动提取视频元信息。默认关闭。取值如下:
说明 对低频存储文件开启此功能将产生数据取回费用。详见低频存储计费。 |
MetaGetMd5 | String | 否 | disabled | 是否全量提取 MD5。默认情况下,系统仅对大小在 16 MB 以内的文件提取 MD5 信息。开启此功能后,系统将提取所有上传文件的 MD5 信息。取值如下:
说明 提取 MD5 需要全量下载视频,可能导致元信息提取速度变慢,建议仅在必要时启用。 |
本接口无特有的返回参数。具体请见公共返回参数。
POST https://vod.volcengineapi.com?Action=UpdateUploadSpaceConfig&Version=2023-07-01 { "SpaceName": "docspace", "AutoPoster": "enabled", "CustomPosterConfig": { "CustomTemplateStatus": "enabled", "PathTemplate": "{{fileName}}" }, "GetPosterMode": "sync", "AutoTranscode": "disabled", "AutoSetVideoStatus": "published", "UploadOverwrite": "disabled", "CallbackReturnPlayUrl": "enabled", "CallbackReturnRunId": "enabled", "GetMetaMode": "default", "AutoGetArchiveVideoMeta": "disabled", "AutoGetIAVideoMeta": "disabled", "MetaGetMd5": "disabled" }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "UpdateUploadSpaceConfig", "Version": "2023-07-01", "Service": "vod", "Region": "cn-north-1" } }
本接口无特有的错误码。更多信息请见公共错误码。