UpdateLivePadPreset - 更新直播垫片配置--视频直播-火山引擎

文档中心

立即注册

导航

UpdateLivePadPreset - 更新直播垫片配置

最近更新时间：2025.08.21 15:23:37首次发布时间：2025.05.28 15:48:43

调用 UpdateLivePadPreset 接口更新直播垫片配置模板，支持配置垫片类型、断流等待时间、垫片时长以及垫片素材地址或图像数据。通过该接口，您可以灵活设置直播中断时的替代内容，提升观众体验。

注意事项

计费说明：垫片为收费功能，费用详细说明详见垫片计费。
请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
PresetName	String	是	`default_preset`	待更新的垫片模板名称。
Vhost	String	是	`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` 级别的配置
Description	String	否	`默认垫片配置`	垫片模板的描述信息，用于详细说明该模板的用途或特性，最大长度为 `1024` 字节。
PadType	Integer	是	`1`	垫片类型，取值及含义如下所示。 `1`：图片； `2`：视频； `3`：源流最后一帧。
WaitDuration	Long	是	`1000`	断流等待时间，即直播断流后等待播放垫片的时长，单位为毫秒，取值范围为 `[0,6000]`。
MaxDuration	Long	是	`6000`	垫片最大播放时长，单位为毫秒，取值范围为 `[1000,1000000000]`。
Url	String	否	`https://example.com/pad-material.mp4`	垫片素材的地址，用于指定垫片播放时使用的图片或视频资源。当 `PadType = 1`（图片）或 `PadType =2`（视频）时有效；当 `PadType = 3`（源流最后一帧）无效。

返回参数

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

请求示例

POST https://live.volcengineapi.com?Action=UpdateLivePadPreset&Version=2023-01-01
{
    "PresetName": "default_preset",
    "Description": "默认垫片配置",
    "PadType": 1,
    "WaitDuration": 1000,
    "MaxDuration": 6000,
    "Url": "https://example.com/pad-material.mp4",
    "Vhost": "push.example.com",
    "App": "live",
    "Stream": "stream001"
}

返回示例

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

错误码

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

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