All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveCenterTransfer

Last Updated:Sep 27, 2024

Queries the information about a configuration of live center stream relay.

Operation description

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

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:DescribeLiveCenterTransferget
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The streaming domain.

example.com
AppNamestringNo

The name of the application to which the live stream belongs. The value of this parameter must be the same as the application name specified in the ingest URL. Otherwise, the configuration does not take effect.

testapp
StreamNamestringNo

The name of the live stream.

teststream
DstUrlstringNo

The third-party URL to which the live stream is relayed.

rtmp://push.example2.aliyunlive.com/testapp1/teststream2

Response parameters

ParameterTypeDescriptionExample
object
LiveCenterTransferInfoListarray<object>

The stream relay information.

LiveCenterTransferInfoobject
AppNamestring

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

teststream
DomainNamestring

The streaming domain.

example.com
DstUrlstring

The third-party URL to which the live stream is relayed.

rtmp://push.example2.aliyunlive.com/testapp1/teststream2
EndTimestring

The end time of stream relay.

2022-04-29T15:16:00Z
StartTimestring

The start time of stream relay.

2022-04-28T15:16:00Z
StreamNamestring

The name of the live stream.

teststream
TransferArgsstring

The validity period of stream relay. Valid values:

  • always: The stream can always be relayed.
  • time: The stream can be relayed in a specified time period.
time
RequestIdstring

The request ID.

C4865B85-664B-19D3-BB16-C62FB83C8226

Examples

Sample success responses

JSONformat

{
  "LiveCenterTransferInfoList": {
    "LiveCenterTransferInfo": [
      {
        "AppName": "teststream",
        "DomainName": "example.com",
        "DstUrl": "rtmp://push.example2.aliyunlive.com/testapp1/teststream2",
        "EndTime": "2022-04-29T15:16:00Z",
        "StartTime": "2022-04-28T15:16:00Z",
        "StreamName": "teststream",
        "TransferArgs": "time"
      }
    ]
  },
  "RequestId": "C4865B85-664B-19D3-BB16-C62FB83C8226"
}

Error codes

HTTP status codeError codeError message
400InvalidParamParameter invalid.
500InternalErrorThe request processing has failed due to backend service exception.

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

Change history

Change timeSummary of changesOperation
2023-03-28The Error code has changedView Change Details