调用 DescribeLivePadPresetDetail 接口查询指定直播流的垫片模板列表，返回包含垫片类型（图片/视频/最后一帧）、持续时间、素材 URL 等详细配置。通过此接口可快速获取当前流的备用内容方案，用于直播中断时的无缝衔接播放。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeLivePadPresetDetail | 接口名称。当前 API 的名称为 DescribeLivePadPresetDetail。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Vhost | String | 否 | push.example.com | 域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面获取。 |
App | String | 否 |
| 应用名称，取值与直播流地址的 说明
|
Stream | String | 否 |
| 流名称，取值与直播流地址的 StreamName 字段取值相同，由 1 到 100 位数字（0 - 9）、大写小字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成。 说明
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PresetList | Array of PresetList | [{"Vhost":"example.com","App":"live","Stream":"stream1","PresetDetail":{"PadType":1,"WaitDuration":10,"MaxDuration":3600,"Url":"http://example.com/pad.jpg","Description":"默认垫片","PresetName":"default_preset"}}] | 模板列表，包含每个模板的详细信息，如域名空间、应用名称、流名称以及模板详情。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vhost | String | push.example.com | 域名空间。 |
| App | String | live | 应用名称，用于标识特定的应用。 |
| Stream | String | stream1 | 流名称，用于标识特定的直播流。 |
| PresetDetail | Object of PresetDetail | - | 模板详情。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
PadType | Integer |
| 垫片类型，取值如下所示。
|
| WaitDuration | Long | 10000 | 等待持续时间，单位为毫秒。表示在触发垫片播放前需要等待的时间长度。 |
| MaxDuration | Long | 3600 | 最大持续时间，单位为毫秒。表示垫片播放的最长时间限制。 |
| Url | String | https://live.example.com/video.mp4 | 垫片素材的公网可访问地址。确保提供的地址能够被公网正常访问，以便正确加载垫片素材内容。 |
| Description | String | 默认垫片 | 垫片模板的描述信息，用于说明该垫片模板的具体用途或特性。 |
| PresetName | String | default_preset | 模版名称，用于标识特定的垫片模板配置。 |
POST https://live.volcengineapi.com?Action=DescribeLivePadPresetDetail&Version=2023-01-01 { "Vhost": "vhost", "App": "app", "Stream": "stream" }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "DescribeLivePadPresetDetail", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "PresetList": [ { "Vhost": "", "App": "", "Stream": "", "PresetDetail": { "PadType": 1, "WaitDuration": 3000, "MaxDuration": 3000, "Url": "", "Description": "", "PresetName": "preset1" } } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 400 | InvalidParam.Empty | %s is required | 参数缺失，请检查错误消息中指定的参数是否传入。 |
| 400 | InvalidParam.Format | %s format error | 参数格式错误，请检查错误消息中指定参数中是否存在非法字符或 URL 格式错误。 |
| 400 | InvalidParam.Length | %s should not be longer than %d | 参数长度错误，请检查错误消息中指定参数的长度是否超过限制。 |
| 400 | InvalidParam.OutOfRange | %s should be one of {[%s]}%s should be between %d and %d | 参数超出允许范围，请检查错误消息中指定参数的取值是否超出取值范围。 |
| 400 | InvalidParam.TimeLogic | startTime later than endTime, etc. | 传入的时间参数不符合时间逻辑，请检查是否存在以下问题。开始时间晚于结束时间或过期时间早于当前时间。 |
| 400 | InvalidParam.DomainAndApp | domain and app exist can not exist at the same time | 入参不能同时传入 Domain 和 App ，请修改入参。 |
| 400 | InvalidParam.VhostOrDomainEmpty | Please enter vhost or domain | 入参需传入 Vhost 或 Domain 中的任意一个，请修改入参。 |
| 400 | InvalidParam.StillUsing | %s is still in use, can't delete | 服务正在使用错误消息中指定的资源导致，无法删除，请释放资源后重试。 |
| 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.VhostNotExist | vhost not found | 未找到域名空间（Vhost）。请检查传入的域名空间是否与实际使用的域名空间一致。 |
| 404 | ResourceNotFound.DomainNotExist | domain not found | 未找到域名（Domain）。请检查传入的域名是否与实际使用的域名一致。 |
| 404 | ResourceNotFound.AppNotExist | app not found | 未找到应用（App）。请检查传入的应用名称是否与实际使用的应用名称一致。 |
| 404 | ResourceNotFound.PresetNotExist | preset not found | 未找到配置模版。请检查传入的配置模版与创建好的配置模板是否一致。 |
| 429 | RequestLimitExceeded | - | 请求创建的资源（域名空间、域名、应用、配置模版、证书）超出限制。 |
| 429 | RequestLimitExceeded.Exist | %s already exist | 请求创建的资源（域名空间、域名、应用、配置模版、证书）已存在。 |
| 500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误，请联系技术支持。 |
| 500 | InternalError.DB | an internal error related to database occurred, please contact the administrator. | 出现与数据库相关的内部错误，请联系技术支持。 |
| 500 | InternalError.VhostOrDomain | an internal error related to vhost or domain occurred, please contact the administrator. | 出现与域名空间（Vhost）或域名（Domain）相关的内部错误。请联系技术支持。 |
| 500 | InternalError.ServicesOrBilling | an internal error related to service or billing occurred, please contact the administrator. | 出现与服务或账单相关的内部错误，请联系技术支持。 |
| 500 | InternalError.Preset | an internal error related to preset occurred, please contact the administrator. | 出现与功能配置相关的内部错误，请联系技术支持。 |
| 500 | InternalError.Stream | an internal error related to stream 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. | 服务间出现错误，请联系技术支持。 |
| 502 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时，请联系技术支持。 |