All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveEdgeTransfer

Last Updated:Dec 05, 2024

Queries the configuration of edge stream relay.

Operation description

Obtain the ingest domain, and then call this operation to query the configuration of edge 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.

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:DescribeLiveEdgeTransferget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The ingest domain.

demo.aliyundoc.com

Response parameters

ParameterTypeDescriptionExample
object
HttpDnsstring

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

http://developer.aliyundoc.com/****
AppNamestring

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

liveApp****
RequestIdstring

The request ID.

53FCB985-C67C-467B-B2B3-398430A21E14
TransferArgsstring

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.
yes
StreamNamestring

The name of the ingested stream.

liveStream****
TargetDomainListstring

The destination domain names to which the ingested stream is relayed. Multiple domain names are separated by commas (,).

learn.aliyundoc.com,guide.aliyundoc.com
DomainNamestring

The ingest domain.

demo.aliyundoc.com

Examples

Sample success responses

JSONformat

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

HTTP status codeError codeError messageDescription
400InvalidParamParameter invalid.Illegal input parameters
500InternalErrorThe request processing has failed due to backend service exception.-

For a list of error codes, visit the Service error codes.