DescribeLiveCenterTransfer API Reference - ApsaraVideo Live - Alibaba Cloud -

Queries the live center stream relay configuration by calling DescribeLiveCenterTransfer.

Operation description

The queries per second (QPS) limit for a single user on this operation is 100. Requests that exceed this limit are throttled, which may affect your business. Call this operation appropriately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveCenterTransfer

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	No	The name of the live stream application. The AppName you enter must match the AppName of the live stream to be relayed for the configuration to take effect. You can view the AppName on the Stream Management page.	testapp
StreamName	string	No	The name of the live stream. You can view the StreamName on the Stream Management page.	teststream
DstUrl	string	No	The third-party live streaming URL to which the stream is relayed.	rtmp://push.example2.aliyunlive.com/testapp1/teststream2

Response elements

Element	Type	Description	Example
	object
LiveCenterTransferInfoList	object
LiveCenterTransferInfo	array<object>	The list of live stream relay services.
	object	The list of live stream relay services.
AppName	string	The application name.	teststream
DomainName	string	The streaming domain.	example.com
DstUrl	string	The third-party URL to which the live stream is relayed.	rtmp://push.example2.aliyunlive.com/testapp1/teststream2
EndTime	string	The end time of stream relay.	2022-04-29T15:16:00Z
StartTime	string	The start time of stream relay.	2022-04-28T15:16:00Z
StreamName	string	The stream name.	teststream
TransferArgs	string	The validity period of the stream relay configuration. Valid values: always: The configuration is permanently valid. time: The configuration is valid for a specified period.	time
RequestId	string	The request ID.	C4865B85-664B-19D3-BB16-C62FB83C8226

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidParam	Parameter invalid.	Illegal input parameters
500	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.