All Products
Search
Document Center

ApsaraVideo Live:OpenLiveShift

Last Updated:Nov 14, 2024

Enables time shifting for a domain name, or enables time shifting for 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

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

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 use the wildcard (*) to specify all applications under the domain name.

liveApp****
StreamNamestringNo

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

liveStream****
DurationintegerNo

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

3
VisionintegerNo

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

10
IgnoreTranscodebooleanNo

Whether to ignore time shift generation for the transcode stream.

  • true: Ignore time shifting generation.
  • false: Generate time shifting.

The default value is true.

true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Special error codes

Error codeError messageHTTP status codeDescription
InvalidParamparam error400The error message returned because one or more specified parameters are invalid.
InvalidDataNotFounddata not found404The error message returned because user data cannot be found.

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