Queries the configuration of edge node stream relay.

Usage notes

Obtain the streaming domain, and then call this operation to query the configuration of edge node stream relay.

QPS limit

You can call this API operation up to 100 times per second 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

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.

Response parameters

Parameter Type Example Description
HttpDns String http://developer.aliyundoc.com/****

The HTTPDNS API that is used to obtain the destination URLs.

AppName String liveApp****

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

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

The ID of the request.

TransferArgs String yes

Specifies whether pass-through is enabled for parameters in the ingest URL. Valid values:

  • yes: Pass-through is enabled for parameters in the ingest URL.
  • no: Pass-through is disabled for parameters in the ingest URL.
StreamName String liveStream****

The name of the ingested stream.

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

The destination domain names to which the ingested stream is relayed. Separate multiple domain names with commas (,).

DomainName String demo.aliyundoc.com

The ingest domain.

Examples

Sample request

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

Sample success responses

XML format 

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

<?xml version="1.0" encoding="UTF-8" ?>
<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 

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

{
  "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.