You need to enable JavaScript to run this app.
导航
UpdateUploadSpaceConfig - 更新空间上传配置
最近更新时间:2025.04.28 15:11:37首次发布时间:2025.04.28 15:11:37
我的收藏
有用
有用
无用
无用

调用 UpdateUploadSpaceConfig 接口更新空间上传配置,实现自动生成封面、自动转码等功能。

使用说明

  • 此接口为模块级别覆盖修改:
    • 若调用接口时设置了某个模块的参数,该模块的现有配置将被覆盖。
    • 若调用接口时未设置某个模块的参数,该模块的配置将保持不变。
  • 上传设置对空间内所有上传的音视频类型媒资生效。

注意事项

  • 本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

请求说明

  • 请求方式:POST
  • 请求地址:https://vod.volcengineapi.com?Action=UpdateUploadSpaceConfig&Version=2023-07-01

调试

请求参数

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

Query

参数
类型
是否必选
示例值
描述
Action
String
UpdateUploadSpaceConfig
接口名称。当前 API 的名称为 UpdateUploadSpaceConfig
Version
String
2023-07-01
接口版本。当前 API 的版本为 2023-07-01

Body

参数
类型
是否必选
示例值
描述
SpaceName
String
docspace
点播空间名。
AutoPoster
String
enabled

是否开启自动生成封面。默认关闭。开启后,视频上传成功时,系统自动选取首张非黑帧(黑帧标准:黑色元素占比超 80%)作为封面。取值如下:

  • enabled: 启用。
  • disabled: 禁用。

说明

完整使用流程,请见设置视频封面

CustomPosterConfig
Object
-
自定义封面配置。仅当 AutoPosterenabled 时生效。
CustomTemplateStatus
String
enabled

是否开启自定义封面配置。默认关闭。开启后,您需设置 PathTemplate 参数自定义生成的封面图文件路径。取值如下:

  • enabled: 启用。
  • disabled: 禁用。
PathTemplate
String
abc.jpeg

自定义生成的封面图文件路径。您可以输入固定字符串和变量。详情规则请参见自定义媒体处理输出文件路径

注意

  • 不支持以 /\ 开头。
  • 不支持连续 /、空格、+ 等特殊字符。
  • 不支持 {{count}} 变量。
GetPosterMode
String
sync

封面提取方式:

  • sync: 同步提取。系统将优先同步提取封面,适用于上传完成后需要立即获取媒资封面的场景,但上传速度弱于异步提取。
  • async: 异步提取。系统将异步提取封面,适用于对上传速度要求较高的场景。
AutoTranscode
String
disabled

是否开启自动触发工作流。默认关闭。取值如下:

  • enabled: 启用。
  • disabled: 禁用。
TranscodeConfig
Object
-
转码配置。仅当 AutoTranscodeenabled 时生效。
DefaultTemplateStatus
String
enabled

是否开启自定义转码配置。默认关闭。开启后,您需设置 DefaultTemplateId 参数自定义工作流 ID。取值如下:

  • enabled: 启用。
  • disabled: 禁用。
DefaultTemplateId
String
e89f4d08d1b94e208aa5bbb7db285dbd
工作流 ID。您可在视频点播控制台创建工作流并获取工作流 ID,详见工作流
AutoSetVideoStatus
String
published

自动设置视频状态。在视频点播中,音视频资源的发布状态分为发布和未发布。默认情况下,上传到视频点播的音视频为未发布状态,无法获取播放地址进行播放。因此,在播放音视频之前,您必须将音视频的发布状态修改为已发布。取值如下:

  • published: 自动发布上传到视频点播的音视频。
  • unpublished: 不发布上传到视频点播的音视频。
UploadOverwrite
String
disabled

是否开启覆盖上传。默认关闭。开启后,上传具有相同文件路径的新媒资文件时,会替换之前上传的旧媒资文件。取值如下:

  • enabled: 启用。
  • disabled: 禁用。

注意

覆盖上传可能导致图床安全风险,如果没有适当的安全措施和权限管理,可能被攻击者滥用为注入恶意内容或删除重要文件的方式,请谨慎评估后开启。

CallbackReturnPlayUrl
String
enabled

上传完成回调是否返回媒资播放地址。默认关闭。开启后,媒资上传完成事件中会返回视频播放地址。取值如下:

  • enabled: 上传完成回调返回媒资播放地址。
  • disabled: 上传完成回调不返回媒资播放地址。

注意

您还需将 AutoSetVideoStatus 参数设为 published,才能获取播放地址。

CallbackReturnRunId
String
disabled

上传完成回调是否返回工作流任务 ID。默认关闭。开启后,如果您在上传音视频时触发工作流任务,媒资上传完成事件中会返回工作流任务 ID。取值如下:

  • enabled: 上传完成回调返回工作流任务 ID。
  • disabled: 上传完成回调不返回工作流任务 ID。
GetMetaMode
String
default

视频元信息提取方式。对于上传到视频点播、标准存储的音视频资源,视频点播默认会提取视频分辨率、时长、码率等元信息。取值如下:

  • defalut: (默认)同步+异步提取。优先同步提取,仅在极少数同步提取超时的情况下采用异步提取。同步提取元信息是指在 CommitUploadInfo 接口中提取元信息。适用于上传完成后需要立即获取媒资信息的情况。
  • async: 异步提取,采用全异步提取,适用于对上传速度要求较高的场景。
AutoGetArchiveVideoMeta
String
disabled

归档存储的媒资是否自动提取视频元信息。默认关闭。取值如下:

  • enabled: 开启。
  • disabled: 禁用。

说明

对归档存储文件开启此功能会产生归档数据取回费用。详见归档存储计费

AutoGetIAVideoMeta
String
disabled

低频存储的媒资是否自动提取视频元信息。默认关闭。取值如下:

  • enabled: 启用。
  • disabled: 禁用。

说明

对低频存储文件开启此功能将产生数据取回费用。详见低频存储计费

MetaGetMd5
String
disabled

是否全量提取 MD5。默认情况下,系统仅对大小在 16 MB 以内的文件提取 MD5 信息。开启此功能后,系统将提取所有上传文件的 MD5 信息。取值如下:

  • enabled: 启用。
  • disabled: 禁用。

说明

提取 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"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码