All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveLazyPullStreamConfig

Last Updated:Nov 14, 2024

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

Operation description

This operation is applicable to regular stream pulling. You can call this operation to query the configurations of regular stream pulling for a domain name.

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 limit on an API operation in ApsaraVideo Live.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveLazyPullStreamConfigget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The main streaming domain.

example.com
AppNamestringNo

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

liveApp****

Response parameters

ParameterTypeDescriptionExample
object

The stream pulling configurations.

RequestIdstring

The ID of the request.

A3136B58-5876-4168-83CA-B562781981A0
LiveLazyPullConfigListarray<object>

The configurations of triggered stream pulling.

LiveLazyPullConfigobject

The configuration of triggered stream pulling.

AppNamestring

The name of the application.

liveApp****
PullArgsstring

The parameters of back-to-origin stream pulling.

k=v
PullAppNamestring

The name of the application for back-to-origin stream pulling. If the application specified in the streaming URL is used, this parameter is left empty.

livePullApp****
PullProtocolstring

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

  • rtmp
  • httpflv
  • hls
RTMP
PullDomainNamestring

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

guide.aliyundoc.com
DomainNamestring

The main streaming domain.

example.com
TranscodeLazystring

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

  • yes
  • no
no

Examples

Sample success responses

JSONformat

{
  "RequestId": "A3136B58-5876-4168-83CA-B562781981A0",
  "LiveLazyPullConfigList": {
    "LiveLazyPullConfig": [
      {
        "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, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-23The response structure of the API has changedView Change Details

Special error codes

Error codeError messageError messageDescription
Missing DomainNameDomainName is mandatory for this action.400One or more required parameters are not specified.
InvalidDomain.NotFoundThe domain provided does not exist in our records.404The domain name is not found within your Alibaba Cloud account.