You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/直播垫片/CreateLivePadPreset - 创建直播垫片配置
CreateLivePadPreset - 创建直播垫片配置
最近更新时间：2025.05.28 15:48:43首次发布时间：2025.05.28 15:48:43
我的收藏
有用
有用
无用
无用

调用 CreateLivePadPreset 接口可创建直播垫片配置。当直播流断开（包括主动断开）时，系统将自动切换至指定素材或最后一帧画面。直播恢复后，画面将自动切回直播内容。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 生效说明：新增、更新或删除垫片配置后，需等待 3–5 分钟，并重新推流，配置才会生效。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=CreateLivePadPreset&Version=2023-01-01

调试

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是CreateLivePadPreset接口名称。当前 API 的名称为 CreateLivePadPreset。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面获取。

App

String

否

live

应用名称，取值与直播流地址的 AppName 字段取值相同，由 1 到 30 位数字（0 - 9）、大写小字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，默认为空。

说明

  • App 取值为空时，Stream 取值也需为空，表示垫片配置为 Vhost 级别的全局配置。
  • App 取值不为空时，Stream 取值含义请参见 Stream 参数说明。

Stream

String

否

stream001

流名称，取值与直播流地址的 StreamName 字段取值相同，由 1 到 100 位数字（0 - 9）、大写小字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成。

说明

  • App 取值不为空、Stream 取值为空时，表示垫片配置为 Vhost + App 级别的配置。
  • App 取值不为空、Stream 取值不为空时，表示垫片配置为 Vhost + App + Stream 级别的配置
DescriptionString否Description info配置的描述信息，最大支持 1024 个字节的输入。

PadType

Integer

是

1

垫片类型，取值及含义如下所示。

  • 1：图片；
  • 2：视频；
  • 3：源流最后一帧。
UrlString否https://example.png垫片素材的地址。当 PadType 设置为“最后一帧”时，该参数不生效。
WaitDurationLong是1000断流等待时间，即直播断流后等待播放垫片的时长，单位为毫秒，取值范围为 [0,6000]。
MaxDurationLong是6000垫片最大播放时长，单位为毫秒，取值范围为 [1000,1000000000]。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://live.volcengineapi.com?Action=CreateLivePadPreset&Version=2023-01-01
{
    "PadType": 1,
    "WaitDuration": 1000,
    "MaxDuration": 6000,
    "Url": "https://example.png",
    "Vhost": "push.example.com",
    "App": "live",
    "Stream": "stream001"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateLivePadPreset",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
429RequestLimitExceeded.Exist%s already exist请求创建的资源（域名空间、域名、应用、配置模版、证书）已存在。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.Presetan internal error related to preset occurred, please contact the administrator.出现与功能配置相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。