QueryLiveDomainMultiStreamList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the online records of dual-stream disaster recovery.

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 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 support 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 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. For more information, see Common condition keys.
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:QueryLiveDomainMultiStreamList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Domain	string	Yes	The main streaming domain.	demo.aliyundoc.com
StreamName	string	No	The name of the live stream. This parameter is used for exact match.	teststream
StartTime	string	No	The beginning of the time range to query. The format is: yyyy-MM-ddTHH:mm:ssZ (UTC time). The time range specified by the StartTime and EndTime parameters cannot exceed seven days.	2024-12-01T01:00:00Z
EndTime	string	No	The end time. The format is: yyyy-MM-ddTHH:mm:ssZ (UTC time). The end time must be later than the start time. The time range specified by the StartTime and EndTime parameters cannot exceed seven days. If the two parameters are not specified, data of the last 24 hours is queried by default.	2024-12-02T01:00:00Z
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Valid values: 1 to 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	CF60DB6A-7FD6-426E-9288-122CC1A5****
PageNumber	integer	The page number returned.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries returned.	19
OnlineStreams	array	The online streams returned.
	object
Domain	string	The main streaming domain.	play.***.com
AppName	string	The application name.	apptest
StreamName	string	The name of the live stream.	teststream
OptimalMode	string	Indicates whether the feature is enabled. Valid values: on: enabled off: disabled	on
UpstreamList	array	The standby streams.
	object
UpstreamSequence	string	The unique identifier of the stream ingest.	***test_Alirewrite1
UpstreamIp	string	The IP address of the stream ingest client.	1.1.1.1
UpstreamTime	string	The stream ingest time.	2024-11-13T09:20:47Z
MasterFlag	boolean	The active/standby tag. Note This tag indicates which stream is used for merged stream distribution.	false
ChangeLogs	array	The switchover records.
	object
ChangeTime	string	The switchover time.	2024-11-13T09:20:47Z
ChangeReason	string	The reason for the switchover merge cut manually: You proactively switched the stream. master stream no data: No data is available in the active stream. master stream low quality: The quality of the active stream deteriorated.	merge cut manually
MasterUpstream	string	The stream used after the switchover.	rtmp://118.178.168.35:1936/wwMultitest/pull.livetest2.aliyunlive.com_wwMultitest428_AliRewrite_2?vhost=pull.livetest2.aliyunlive.com&live_rtmp_test=on
UpstreamSequence	string	The identifier of the stream after the switchover.	***test_AliRewrite_2
UpstreamIp	string	The IP address used after the switchover.	1.1.1.1

Examples

Successful response

JSON format

{
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A5****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 19,
  "OnlineStreams": [
    {
      "Domain": "play.***.com",
      "AppName": "apptest",
      "StreamName": "teststream",
      "OptimalMode": "on",
      "UpstreamList": [
        {
          "UpstreamSequence": "***test_Alirewrite1",
          "UpstreamIp": "1.1.1.1",
          "UpstreamTime": "2024-11-13T09:20:47Z",
          "MasterFlag": false
        }
      ],
      "ChangeLogs": [
        {
          "ChangeTime": "2024-11-13T09:20:47Z",
          "ChangeReason": "merge cut manually",
          "MasterUpstream": "rtmp://118.178.168.35:1936/wwMultitest/pull.livetest2.aliyunlive.com_wwMultitest428_AliRewrite_2?vhost=pull.livetest2.aliyunlive.com&live_rtmp_test=on",
          "UpstreamSequence": "***test_AliRewrite_2",
          "UpstreamIp": "1.1.1.1"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	%s.	Parameter error
400	InvalidParam.CodeIllegalDuration	%s.	The value of start time should be less than the value of end time .
500	InternalError	%s.	error on the live liveapi server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.