OpenLiveShift - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

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

QPS limit

This operation supports up to 10 queries per second (QPS) per user. If you exceed this limit, the system throttles your API calls, which can impact your business. To prevent throttling, call this operation at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:OpenLiveShift

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain name.	example.com
AppName	string	No	The name of the application. The wildcard character () is supported. An asterisk () represents all applications under the specified domain name. For more information, see Stream management.	liveApp****
StreamName	string	No	The name of the stream. The wildcard character () is supported. An asterisk () represents all streams under the specified application. For more information, see Stream management.	liveStream****
Duration	integer	No	The duration of an HTTP Live Streaming (HLS) transport stream (TS) segment. Unit: seconds.	3
Vision	integer	No	The data retention period. The default value is 7. Unit: days.	10
IgnoreTranscode	boolean	No	Specifies whether to enable time shifting for transcoded streams. Valid values: true: Time shifting is disabled for transcoded streams. false: Time shifting is enabled for transcoded streams. Default value: true.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	ConfigAlreadyExists	%s Please check and try again later.	Configuration already exists, please check and try again.
400	InvalidParam	%s.	Parameter verification failed
404	InvalidDataNotFound	%s, please check and try again later.	Data does not exist, please check and try again.
409	InvalidStreamNum	%s, please check and try again later.	The number of streams is abnormal. Please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.