All Products
Search
Document Center

:DescribeLiveEdgeTransfer

Last Updated:Jun 27, 2024

Queries the configuration of edge node stream relay.

Usage notes

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

QPS limit

You can call this 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 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 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 request ID.

TransferArgs String yes

Indicates whether stream ingest parameters are passed through. Valid values:

  • yes: Stream ingest parameters are passed through.
  • no: Stream ingest parameters are not passed through.
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. Multiple domain names are separated by commas (,).

DomainName String demo.aliyundoc.com

The ingest domain.

Examples

Sample requests

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

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

JSON format

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

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

Error codes

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