AddLivePullStreamInfoConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Creates a scheduled stream pulling configuration, which includes parameters such as the origin URL, start time, and end time.

Operation description

Before you call this operation, make sure that you understand the billing method and pricing of ApsaraVideo Live. For more information, see Billing of standard streaming.
Stream pulling refers to the process of pulling live streams from third-party URLs to a live center of ApsaraVideo Live for CDN acceleration.
This operation supports only scheduled stream pulling. You can specify a start time and an end time to pull a live stream during a specific time period.
The console supports both scheduled and triggered stream pulling. For more information, see Configure stream pulling.
You can specify custom values for the AppName and StreamName parameters. Streaming URLs are generated based on AppName and StreamName. You can use the URL generator to generate a streaming URL.
Each stream pulling configuration must be unique. The combination of DomainName, AppName, and StreamName can only be associated with one active configuration. Attempting to add a duplicate configuration will result in an error.

QPS limit

You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

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:AddLivePullStreamInfoConfig

create

*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 where the ingested stream will be hosted and distributed from.	example.com
AppName	string	Yes	The custom name of the application.	liveApp****
StreamName	string	Yes	The custom name of the live stream.	liveStream****
SourceUrl	string	Yes	The origin URL of the live stream. You can specify multiple URLs. Separate them with semicolons (;). Note You can pull only live streams in the RTMP, FLV, HLS, and SRT formats.	rtmp://guide.aliyundoc.com/liveApp**/liveStream;rtmp://developer.aliyundoc.com/liveApp/liveStream**
StartTime	string	Yes	The time when stream pulling starts. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-21T08:00:00Z
EndTime	string	Yes	The time when stream pulling ends. The time range specified by the StartTime and EndTime parameters cannot exceed seven days. The time must be later than the current time. Specify the value in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-22T08:00:00Z

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time or current time.
400	Duration.Exceed	Duration between StartTime and EndTime is too long.
400	ConfigAlreadyExists	Config has already exist.
400	PullStreamOverLimit	Pull stream is over limit for this domainName.
400	InvalidParam	Parameter invalid.	Illegal input parameters
500	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.