DescribeLiveStreamsPublishList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the ingest records of a specified domain name, application, or stream.

Operation description

You can query streams in the last 30 days. The active streams during the queried period are returned. This operation supports the following sorting methods:

stream_name_desc: Sorts by stream name in descending order.
stream_name_asc: Sorts by stream name in ascending order.
publish_time_desc: Sorts by ingest time in descending order.
publish_time_asc: Sorts by ingest time in ascending order.

QPS limit

You can call this operation up to 3 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

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:DescribeLiveStreamsPublishList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The ingest or streaming domain. Note Ensure that the domain is added to ApsaraVideo Live and that you have the required permissions to manage it.	example.com
AppName	string	No	The name of the application. To view AppName, go to Stream Management.	liveApp****
StreamName	string	No	The name of the stream. To view StreamName, go to Stream Management.	liveStream****
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-21T08:00:00Z
EndTime	string	Yes	The end of the time range to query. The time range specified by the StartTime and EndTime parameters cannot exceed 30 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-22T08:00:00Z
PageSize	integer	No	The number of entries per page. Valid values: 1 to 3000. Default value: 2000.	1500
PageNumber	integer	No	The page number. Default value: 1.	1
StreamType	string	No	The stream type. Valid values: If you do not specify this parameter, original streams are queried. all: queries all streams. trans: queries transcoded streams.	all
QueryType	string	No	Specifies whether to perform a fuzzy match for the stream name. Valid values: fuzzy (default): fuzzy match. strict: exact match.	fuzzy
OrderBy	string	No	The sorting method. Valid values: stream_name_desc: Sorts by stream name in descending order. stream_name_asc: Sorts by stream name in ascending order. publish_time_desc: Sorts by ingest time in descending order. publish_time_asc (default): Sorts by ingest time in ascending order.	publish_time_desc

Response elements

Parameter	Type	Description	Example
	object
TotalPage	integer	The total number of pages.	2
PageNum	integer	The page number.	2
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	40A4F36D-A7CC-473A-88E7-154F92242566
TotalNum	integer	The total number of entries that meet the criteria.	11
PublishInfo	object
LiveStreamPublishInfo	array<object>	The stream ingest records.
	object
EdgeNodeAddr	string	The IP address of the CDN point of presence (POP) to which the stream was ingested.	10.175.XX.XX
PublishUrl	string	The complete ingest URL.	rtmp://demo.aliyundoc.com/liveApp**/liveStream**
StreamName	string	The stream name.	liveStream****
DomainName	string	The ingest or streaming domain.	example.com
StopTime	string	The time when the stream ingest was stopped. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-02T03:11:19Z
TranscodeId	string	The ID of the transcoding template. Note This parameter is unavailable if the value of the Transcoded parameter is no.	ld
PublishDomain	string	The ingest domain.	demo.aliyundoc.com
AppName	string	The name of the application to which the live stream belongs.	liveApp****
PublishTime	string	The time when the stream ingest was started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-02T03:05:53Z
PublishType	string	The type of the stream ingest. Valid values: edge: edge ingest. center: live center ingest.	edge
Transcoded	string	Indicates whether the stream was a transcoded stream.	yes
ClientAddr	string	The IP address of the client that pushed the live stream.	10.175.XX.XX
StreamUrl	string	The streaming URL.	http://example.com/liveApp**/liveStream**.flv
AliInnerErrorFlags	string	The error code that indicates the cause of a stream interruption. The error code is a one-digit or three-digit number.	002

Examples

Success response

JSON format

{
  "TotalPage": 2,
  "PageNum": 2,
  "PageSize": 10,
  "RequestId": " 40A4F36D-A7CC-473A-88E7-154F92242566",
  "TotalNum": 11,
  "PublishInfo": {
    "LiveStreamPublishInfo": [
      {
        "EdgeNodeAddr": "10.175.XX.XX",
        "PublishUrl": "rtmp://demo.aliyundoc.com/liveApp****/liveStream****",
        "StreamName": "liveStream****",
        "DomainName": "example.com",
        "StopTime": "2015-12-02T03:11:19Z",
        "TranscodeId": "ld",
        "PublishDomain": "demo.aliyundoc.com",
        "AppName": "liveApp****",
        "PublishTime": "2015-12-02T03:05:53Z",
        "PublishType": "edge",
        "Transcoded": "yes",
        "ClientAddr": "10.175.XX.XX",
        "StreamUrl": "http://example.com/liveApp****/liveStream****.flv",
        "AliInnerErrorFlags": "002"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	QpsOverLimit	Qps is over limit for this domainName.
400	InvalidStartTime.Malformed	Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	Specified parameter EndTime is not valid.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.
400	InvalidEndTime.Mismatch	Specified end time does not match the specified start time.
400	Duration.Exceed	Duration between StartTime and EndTime is too long.
400	LiveServiceNotFound	Your account does not open Live service yet	Your account has not yet activated ApsaraVideo Live.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.