AddLivePullStreamInfoConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Before you call this API operation, understand the billing methods and pricing for stream pulling. For more information, see Standard ApsaraVideo Live.
Stream pulling is the process of pulling a third-party live stream to the Alibaba Cloud Live center for accelerated distribution.
This API operation supports only scheduled stream pulling. You must specify a start time and an end time. The stream is pulled only during the specified time period.
The console supports scheduled stream pulling and triggered stream pulling. For more information, see Configure stream pulling.
The AppName and StreamName are customizable. Different values generate different streaming URLs. You can use the URL generator to generate these URLs.
Each (DomainName, AppName, StreamName) tuple can have only one configuration. If a configuration already exists for the tuple, an error is returned when you call this API operation to add another configuration.

QPS limits

The queries per second (QPS) limit for a single user who calls this API operation is 15. If you exceed this limit, your API calls are throttled, which may affect your business. Plan your calls accordingly.

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 stream pulling domain. This must be one of your streaming domains.	example.com
AppName	string	Yes	The name of the application. The name is customizable.	liveApp****
StreamName	string	Yes	The name of the stream. The name is customizable.	liveStream****
SourceUrl	string	Yes	The complete URL of the origin server. To specify multiple origin servers, separate the URLs with semicolons (;). Note Only live streams can be pulled. The RTMP, FLV, HLS, and SRT formats are supported.	rtmp://guide.aliyundoc.com/liveApp**/liveStream;rtmp://developer.aliyundoc.com/liveApp/liveStream**
StartTime	string	Yes	The start time for stream pulling. The interval between the start time and the end time cannot exceed 7 days. The time must be in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2017-12-21T08:00:00Z
EndTime	string	Yes	The end time for stream pulling. The interval between the start time and the end time cannot exceed 7 days. The end time must be later than the current time. The time must be in the yyyy-MM-ddTHH:mm:ssZ format and 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.