文档中心

添加直播时移配置

最近更新时间：2024.03.26 15:28:03

首次发布时间：2023.09.25 14:34:05

调用 CreateTimeShiftPresetV3 接口，添加直播时移配置，直播流配置时移后用户能够在直播过程会看已经播出的内容。

使用说明

添加时移配置时如果选择录制时移，会根据对应 App 级别或 Stream 级别的录制进行时移录制，需要提前创建对应级别的录制配置。录制时移配置创建完成后，时移配置的状态为配置中，您需要创建工单申请启用录制配置，申请通过后，该直播时移配置状态会更新为已启用。
添加时移配置时如果使用独立录制，无需创建对应的录制配置，且配置创建完成后无需通过工单申请，配置状态即为已启用。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
生效时间：配置完成后约 3-5 分钟生效，配置生效后需要重新推流才会进行时移，对正在进行中的直播流，新添加的时移配置不生效。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`push.example.com`	域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要时移的直播流使用的域名所属的域名空间。
App	String	是	`live`	应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
Stream	String	否	`example_stream`	流名称，取值与直播流地址中 StreamName 字段取值相同，默认为空表示当前应用下的所有流都进行时移。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。说明流名称不为空时，表示只为此条流开启时移。通过流名称配置时移时，同一个 App 最多可指定 20 路流开启时移。
MaxShiftTime	Integer	是	`86400`	最大时移时长，即允许用户回看的最长时间，单位为秒，支持的取值如下所示。 `86400`：1 天； `259200`：3 天； `604800`：7 天； `1296000`：15 天。
PullDomain	String	是	`testpull`	时移拉流域名。说明录制到 TOS 时，需配置直播流对应的拉流域名。录制到 VOD 时，需配置 VOD 的空间对应的分发域名。
TimeShiftType	Integer	否	`0`	时移类型。支持的取值如下所示。 `0`：录制时移，即时移复用录制配置，需提前创建对应级别的录制配置； `1`：独立时移，即时移不复用录制配置。

返回参数

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

请求示例

POST https://live.volcengineapi.com?Action=CreateTimeShiftPresetV3&Version=2023-01-01
{
  "Vhost": "push.example.com",
  "App": "live",
  "Stream": "example_stream",
  "MaxShiftTime": 86400,
  "TimeShiftType": 0,
  "PullDomain": "testpull"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20220726*******************051B513A",
        "Action":"CreateTimeShiftPresetV3",
        "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	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
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.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。