All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveLazyPullStreamConfig

Last Updated:Aug 05, 2024

Queries the configurations of triggered stream pulling for a streaming domain.

Usage notes

This operation is applicable to triggered stream pulling.

QPS limit

You can call this operation up to 1,000 times per minute 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. For more information, see QPS limits.

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 DescribeLiveLazyPullStreamConfig

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

DomainName String Yes example.com

The main streaming domain.

AppName String No liveApp****

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

Response parameters

Parameter

Type

Example

Description

RequestId String A3136B58-5876-4168-83CA-B562781981A0

The request ID.

LiveLazyPullConfigList Array of LiveLazyPullConfig

The configurations of triggered stream pulling.

LiveLazyPullConfig
AppName String liveApp****

The application name.

PullArgs String k=v

The parameters of back-to-origin stream pulling.

PullAppName String livePullApp****

The name of the application used for back-to-origin stream pulling. If the application name that is specified in the streaming URL is used, an empty value is returned.

PullProtocol String RTMP

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

  • rtmp
  • httpflv
  • hls
PullDomainName String guide.aliyundoc.com

The domain name for back-to-origin stream pulling.

DomainName String example.com

The main streaming domain.

TranscodeLazy String no

Indicates whether stream pulling is triggered when the transcoded stream is played. Default value: no. Valid values:

  • yes
  • no

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveLazyPullStreamConfig
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveLazyPullStreamConfigResponse>
    <RequestId>A3136B58-5876-4168-83CA-B562781981A0</RequestId>
    <LiveLazyPullConfigList>
        <AppName>liveApp****</AppName>
        <PullArgs>k=v</PullArgs>
        <PullAppName>livePullApp****</PullAppName>
        <PullProtocol>RTMP</PullProtocol>
        <PullDomainName>guide.aliyundoc.com</PullDomainName>
        <DomainName>example.com</DomainName>
        <TranscodeLazy>no</TranscodeLazy>
    </LiveLazyPullConfigList>
</DescribeLiveLazyPullStreamConfigResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A3136B58-5876-4168-83CA-B562781981A0",
  "LiveLazyPullConfigList" : [ {
    "AppName" : "liveApp****",
    "PullArgs" : "k=v",
    "PullAppName" : "livePullApp****",
    "PullProtocol" : "RTMP",
    "PullDomainName" : "guide.aliyundoc.com",
    "DomainName" : "example.com",
    "TranscodeLazy" : "no"
  } ]
}

Error codes

For a list of error codes, see Service error codes.

Special error codes

Error code

Error message

HTTP status code

Description

Missing DomainName

DomainName is mandatory for this action.

400

One or more required parameters are not specified.

InvalidDomain.NotFound

The domain provided does not exist in our records.

404

The domain name is not found within your Alibaba Cloud account.