Automate Stream Pulling Schedules with UpdateLivePullStreamInfoConfig API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

This operation is applicable to fixed stream pulling. Invoke this operation to update the configuration of live stream pulling, including the addresses of the origin server, start time, and end time.

Before invoking this operation, use AddLivePullStreamInfoConfig to create a stream pulling configuration for the specified (DomainName, AppName, StreamName).

Note

After you invoke this operation to modify the configuration, the live streaming service re-executes fixed stream pulling based on the modified configuration. Make sure that the modification does not affect your online services.

QPS limit

The QPS limit for a single user on this operation is 1000 calls per minute. If the limit is exceeded, API calls are throttled, which may affect your business. Invoke this operation appropriately.

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

update

*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 used as the streamer's stream domain. Note When you specify DomainName, make sure that the domain is a live streaming domain and that the user calling this operation has the permission to operate on the specified domain.	example.com
AppName	string	Yes	The name of the application to which the live stream belongs.	liveApp****
StreamName	string	Yes	The name of the live stream.	liveStream****
SourceUrl	string	Yes	The full URL of the origin server where the live stream resides. You can specify multiple origin URLs separated by semicolons (;).	rtmp://guide.aliyundoc.com/liveApp**/liveStream;rtmp://developer.aliyundoc.com/liveApp/liveStream**
StartTime	string	Yes	The start time of stream pulling. The interval between StartTime and EndTime must be within 7 days. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-21T08:00:00Z
EndTime	string	Yes	The end time of stream pulling. The interval between StartTime and EndTime must be within 7 days, and EndTime must be later than the current time. Format: yyyy-MM-ddTHH:mm:ssZ (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	InvalidParam	Parameter invalid.	Illegal input parameters
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	Duration.Exceed	Duration between StartTime and EndTime is too long.
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.