SetLiveStreamPreloadTasks - ApsaraVideo Live - Alibaba Cloud Documentation Center

Configures a prefetch task. You can specify multiple URLs to prefetch at a time.

Operation description

You can call this operation to specify multiple URLs to prefetch at a time. You can specify up to 100 URLs in a request.
URLs in the HTTP Live Steaming (HLS) format are not supported.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
live:SetLiveStreamPreloadTasks		Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain name.	example.com
PlayUrl	string	Yes	The streaming URL. You can specify up to 100 streaming URLs in a request. Separate multiple streaming URLs with commas (,).	rtmp://guide.aliyundoc.com/liveApp**/liveStream**
Area	string	No	The acceleration region where you want to prefetch the live content. Valid values: domestic: regions in the Chinese mainland. overseas: regions outside the Chinese mainland. global: regions in and outside the Chinese mainland. If you do not specify this parameter, the acceleration region configured for the domain name is used.	domestic
PreloadedStartTime	string	No	The start time of the prefetch task. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Example: 2016-06-29T19:00:00Z. If you do not specify this parameter, the prefetch task runs for 1 hour by default.	2016-06-29T19:00:00Z
PreloadedEndTime	string	No	The end time of the prefetch task. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Example: 2016-06-30T19:00:00Z. The interval between the start time and end time cannot exceed 6 hours.	2016-06-30T19:00:00Z

Response parameters

Parameter	Type	Description	Example
	object
FailedURL	integer	The number of URLs for which the prefetch task configuration failed.	0
PreloadTasksMessages	array<object>	The details of the prefetch task.
PreloadTasksMessage	object
Description	string	Indicates whether the prefetch task is successful. Valid values: Successfully InternalError	Successfully
PlayUrl	string	The streaming URL.	rtmp://guide.aliyundoc.com/liveApp**/liveStream**
TaskId	string	The ID of the prefetch task.	yourTaskId
RequestId	string	The ID of the request.	36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5
Status	string	The status of the prefetch task. Valid values: Success Failed Note Success is returned only if the prefetch task is configured for all specified streaming URLs.	Success
SuccessURL	integer	The number of URLs for which the prefetch task is successfully configured.	1
TotalURL	integer	The total number of URLs.	1

Examples

Sample success responses

JSONformat

{
  "FailedURL": 0,
  "PreloadTasksMessages": {
    "PreloadTasksMessage": [
      {
        "Description": "Successfully",
        "PlayUrl": "rtmp://guide.aliyundoc.com/liveApp****/liveStream****",
        "TaskId": "yourTaskId"
      }
    ]
  },
  "RequestId": "36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5",
  "Status": "Success",
  "SuccessURL": 1,
  "TotalURL": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	Parameter invalid.	Illegal input parameters
400	InvalidEndTime.Mismatch	Specified end time does not match the specified start time.	-
400	Duration.Exceed	Duration between StartTime and EndTime is too long.	-
400	QuotaExceeded.PreloadTaskslimit	Exceed max task count limit	-
400	NoSpecialConfiguration	no special configuration for domain name.	The domain name does not open the preheating switch.
500	InternalError	The request processing has failed due to backend service exception.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history