All Products
Search
Document Center

ApsaraVideo Live:OpenLiveShift

Last Updated:Dec 12, 2024

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

Operation description

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

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:OpenLiveShiftget
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The streaming domain.

example.com
AppNamestringNo

The name of the application to which the live stream belongs. You can specify an asterisk (*) as the value to match all applications under the domain name. You can view the application name on the Stream Management page of the ApsaraVideo Live console.

liveApp****
StreamNamestringNo

The name of the live stream. You can specify an asterisk (*) as the value to match all streams in the application. You can view the stream name on the Stream Management page of the ApsaraVideo Live console.

liveStream****
DurationintegerNo

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

3
VisionintegerNo

The duration for which data is retained. Default value: 7. Unit: day.

10
IgnoreTranscodebooleanNo

Specifies whether to disable time shifting for the transcoded stream. Valid values:

  • true: disables time shifting for the transcoded stream.
  • false: enables time shifting for the transcoded stream.

Default value: true.

true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400ConfigAlreadyExists%s
400InvalidParam%s
404InvalidDataNotFound%s
409InvalidStreamNum%s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history