Queries the configurations of live stream transfer for an ingest domain.

Usage note

This operation is applicable to the ingest domains.

QPS limit

A single user can perform a maximum of 100 queries per second (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 DescribeLiveEdgeTransfer

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

DomainName String Yes demo.aliyundoc.com

The ingest domain name.

RegionId String No cn-shanghai

The ID of the region where the ingest domain resides.

Response parameters

Parameter Type Example Description
AppName String liveApp****

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

DomainName String demo.aliyundoc.com

The ingest domain name.

HttpDns String http://developer.aliyundoc.com/****

The HTTPDNS interface that is used to obtain the destination domain names.

RequestId String 53FCB985-C67C-467B-B2B3-398430A21E14

The ID of the request.

StreamName String liveStream****

The name of the ingested stream.

TargetDomainList String learn.aliyundoc.com,guide.aliyundoc.com

The destination domain names to which you want to push ingested streams. Separate multiple domain names with commas (,).

TransferArgs String Yes

Indicates whether pass-through is enabled for parameters related to ingested streams. Valid values:

  • yes: Pass-through is enabled.
  • no: Pass-through is disabled.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeLiveEdgeTransferResponse>
  <StreamName>liveStream****</StreamName>
  <RequestId>53FCB985-C67C-467B-B2B3-398430A21E14</RequestId>
  <DomainName>demo.aliyundoc.com</DomainName>
  <TransferArgs>yes</TransferArgs>
  <HttpDns>http://developer.aliyundoc.com/****</HttpDns>
  <TargetDomainList>learn.aliyundoc.com,guide.aliyundoc.com</TargetDomainList>
  <AppName>liveApp****</AppName>
</DescribeLiveEdgeTransferResponse>

JSON format

{
    "DescribeLiveEdgeTransferResponse": {
        "StreamName": "liveStream****",
        "RequestId": "53FCB985-C67C-467B-B2B3-398430A21E14",
        "DomainName": "demo.aliyundoc.com",
        "TransferArgs": "yes",
        "HttpDns": "http://developer.aliyundoc.com/****",
        "TargetDomainList": "learn.aliyundoc.com,guide.aliyundoc.com",
        "AppName": "liveApp****"
    }
}

Error codes

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