You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒资上传/DescribeUploadSpaceConfig - 获取空间上传配置
DescribeUploadSpaceConfig - 获取空间上传配置
最近更新时间：2025.04.28 15:11:37首次发布时间：2025.04.28 15:11:37
我的收藏
有用
有用
无用
无用

调用 DescribeUploadSpaceConfig 接口获取空间上传配置。

注意事项

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

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

返回参数

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

参数
类型
示例值
描述
AutoPoster
String
enabled

是否开启自动生成封面。取值如下：

  • enabled: 启用。视频上传成功时，系统自动选取首张非黑帧（黑帧标准：黑色元素占比超 80%）作为封面。
  • disabled: 禁用。

说明

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

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

是否开启自定义封面配置。取值如下：

  • enabled: 启用。
  • disabled: 禁用。
PathTemplate
String
abc.jpeg
自定义生成的封面图文件路径。
GetPosterMode
String
sync

封面提取方式：

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

是否开启自动生成封面候选。取值如下：

  • enabled: 启用。开启后，系统将自动从上传视频中抽取 8 个关键帧作为封面候选。
  • disabled: 禁用。

说明

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

AutoTranscode
String
disabled

是否开启自动触发工作流。取值如下：

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

是否开启自定义转码配置。取值如下：

  • enabled: 启用。
  • disabled: 禁用。
DefaultTemplateId
String
e89f4d08d1b94e208aa5bbb7db285dbd
工作流 ID。
AutoSetVideoStatus
String
published

自动设置视频状态。取值如下：

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

是否开启覆盖上传。取值如下：

  • enabled: 启用。上传具有相同文件路径的新媒资文件时，会替换之前上传的旧媒资文件。
  • disabled: 禁用。
CallbackReturnPlayUrl
String
enabled

上传完成回调是否返回媒资播放地址。开启后，取值如下：

CallbackReturnRunId
String
disabled

上传完成回调是否返回工作流任务 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: 禁用。

请求示例

GET https://vod.volcengineapi.com?Action=DescribeUploadSpaceConfig&Version=2023-07-01&SpaceName=docspace

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250415170649949074E00E9EC575BB1F",
    "Action": "DescribeUploadSpaceConfig",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "AutoPoster": "enabled",
    "CustomPosterConfig": {
      "CustomTemplateStatus": "enabled",
      "PathTemplate": "{{fileName}}"
    },
    "GetPosterMode": "sync",
    "AutoPosterCandidate": "enabled",
    "AutoTranscode": "disabled",
    "TranscodeConfig": {
      "DefaultTemplateStatus": "enabled",
      "DefaultTemplateId": "c877db1a8b5046e99a997778b4f1d442"
    },
    "AutoSetVideoStatus": "published",
    "UploadOverwrite": "disabled",
    "CallbackReturnPlayUrl": "enabled",
    "CallbackReturnRunId": "enabled",
    "GetMetaMode": "default",
    "AutoGetArchiveVideoMeta": "disabled",
    "AutoGetIAVideoMeta": "disabled",
    "MetaGetMd5": "disabled"
  }
}

错误码

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