Creates a configuration that triggers stream pulling.

Usage note

The interface is applicable to triggered stream pulling, that is, when the source URL that needs to be pulled starts to play the live stream, ApsaraVideo Live service is automatically triggered to pull the live stream.

Note This interface does not currently support the IPv6 protocol.

QPS limit

A single user can perform a maximum of 1000 queries per minute (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SetLiveLazyPullStreamInfoConfig

The operation that you want to perform. Set the value to SetLiveLazyPullStreamInfoConfig.

AppName String Yes ali_all_app

The name of the application to which the live stream belongs.

Note To allow all applications to trigger back-to-origin stream pulling, set the value to ali_all_app.
DomainName String Yes example.com

The main streaming domain.

PullDomainName String Yes guide.aliyundoc.com

The origin server of the live stream. Separate multiple origin servers with semicolons (;).

PullProtocol String Yes rtmp

The protocol for back-to-origin stream pulling. Valid values:

  • rtmp
  • httpflv
  • hls
PullAppName String No livePullApp****

The application for back-to-origin stream pulling.

Note To use the application specified in the streaming URL, leave this parameter empty.

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CF8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=SetLiveLazyPullStreamInfoConfig
&AppName=ali_all_app
&DomainName=example.com
&PullDomainName=guide.aliyundoc.com
&PullProtocol=rtmp
&<Common request parameters>

Sample success responses

XML format 

<SetLiveLazyPullStreamInfoResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CF8</RequestId>
  </SetLiveLazyPullStreamInfoResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.

Error code

Error message

HTTP status code

Description

InvalidDomain.NotFound

The domain provided does not exist in our records.

404

The error message returned because the domain name does not belong to your Alibaba Cloud account.

IllegalOperation

Illegal domain operate is not permitted.

403

The error message returned because the current operation is not supported. For example, the specified domain name is not a live domain.

Missing DomainName

DomainName is mandatory for this action.

400

The error message returned because a required parameter is not specified.

InternalError

The request processing has failed due to some unknown error.

500

The error message returned because an unknown error has occurred.