DescribeLiveStreamPreloadTasks-阿里云帮助中心

Only data from the last 3 days can be queried.

Operation description

This operation only supports querying data from the last 3 days.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If this limit is exceeded, the API call is throttled, which may affect your business. Call 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:DescribeLiveStreamPreloadTasks

*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.	example.com
TaskId	string	No	The task ID. You can obtain the preload task ID by calling the SetLiveStreamPreloadTasks operation.	yourTaskId
PlayUrl	string	No	The live streaming URL. You can specify multiple URLs separated by commas (,), up to 100.	rtmp://guide.aliyundoc.com/liveApp**/liveStream**
PageSize	integer	No	The number of entries per page. Maximum value: 100. Valid values: any integer from 1 to 100.	10
PageNum	integer	No	The page number to return. Default value: 1.	1
Status	string	No	The task status. Valid values: complete: completed. pending: waiting for preload. preloading: preloading in progress. failed: preload failed. Valid values: pending : Waiting for preload. preloading : Preloading in progress. failed : Preload failed. complete : Completed.	complete
StartTime	string	No	The start time in ISO 8601 format in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. The start time must be within the last 3 days.	2016-06-29T19:00:00Z
EndTime	string	No	The end time in ISO 8601 format in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. The interval between EndTime and StartTime cannot exceed 3 days.	2016-06-30T19:00:00Z

Response elements

Element	Type	Description	Example
	object
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	2
PreloadTasks	object
PreloadTask	array<object>	The details of the live stream preload task.
	object	The details of the live stream preload task.
Area	string	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. Note If you do not specify this parameter, the acceleration region of the domain name is returned.	domestic
CreateTime	string	The time when the prefetch task was created.	2016-06-29T19:00:00Z
Description	string	Indicates whether the prefetch task was successful. Valid values: Successfully InternalError	Successfully
DomainName	string	The streaming domain.	example.com
PlayUrl	string	The live stream URL.	rtmp://guide.aliyundoc.com/liveApp**/liveStream**
PreloadedEndTime	string	The time when the prefetch task ended.	2016-06-30T19:00:00Z
PreloadedStartTime	string	The time when the prefetch task started.	2016-06-29T19:00:00Z
Process	string	The progress of the prefetch task.	100%
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 URLs.	Success
TaskId	string	The task ID.	yourTaskId
RequestId	string	The request ID.	E1564CBC-DCFE-5E1B-8B78-8DED9A39F334
TotalNum	integer	The total number of entries that match the conditions.	1
TotalPage	integer	The total number of pages.	1

Examples

Success response

JSON format

{
  "PageNum": 1,
  "PageSize": 2,
  "PreloadTasks": {
    "PreloadTask": [
      {
        "Area": "domestic",
        "CreateTime": "2016-06-29T19:00:00Z",
        "Description": "Successfully",
        "DomainName": "example.com",
        "PlayUrl": "rtmp://guide.aliyundoc.com/liveApp****/liveStream****",
        "PreloadedEndTime": "2016-06-30T19:00:00Z",
        "PreloadedStartTime": "2016-06-29T19:00:00Z",
        "Process": "100%",
        "Status": "Success",
        "TaskId": "yourTaskId"
      }
    ]
  },
  "RequestId": "E1564CBC-DCFE-5E1B-8B78-8DED9A39F334",
  "TotalNum": 1,
  "TotalPage": 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.
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.