Enables time shifting for a domain name, or enables time shifting for an application or a live stream under the domain name.

Usage note

You cannot configure time shifting and delayed transcoding at the same time.

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes OpenLiveShift

The operation that you want to perform. Set the value to OpenLiveShift.

DomainName String Yes example.com

The streaming domain.

AppName String No liveApp****

The name of the application to which the live stream belongs. You can use the wildcard (*) to specify all applications under the domain name.

StreamName String No liveStream****

The name of the live stream. You can use the wildcard (*) to specify all streams of the application.

Duration Integer No 3

The length of the HTTP Live Streaming (HLS) TS segment. Unit: seconds.

Vision Integer No 10

The number of days for which data is retained. Default value: 7. Unit: day.

IgnoreTranscode Boolean No true Whether to ignore time shift generation for the transcode stream.
  • true: Ignore time shifting generation.
  • false: Generate time shifting.

The default value is true.

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=OpenLiveShift
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format

<OpenLiveShiftResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</OpenLiveShiftResponse>

JSON format

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

For a list of error codes, visit the API Error Center.

Special error codes

Error code

Error message

HTTP status code

Description

InvalidParam

param error

400

The error message returned because one or more specified parameters are invalid.

InvalidDataNotFound

data not found

404

The error message returned because user data cannot be found.