Queries the stream pushing records of a live stream, an application, or a main streaming domain within a specified time period.

Usage note

You can query the stream pushing records of the last 30 days at most. The results can be sorted in one of the following ways:

  • stream_name_desc: Sort the entries in descending order of live stream names.
  • stream_name_asc: Sort the entries in ascending order of live stream names.
  • publish_time_desc: Sort the entries in descending order of pushing time.
  • publish_time_asc: Sort the entries in ascending order of pushing time. This is the default value.

QPS limit

A single user can perform a maximum of 3 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveStreamsPublishList

The operation that you want to perform. Set the value to DescribeLiveStreamsPublishList.

DomainName String Yes example.com

The main streaming domain or ingest domain.

EndTime String Yes 2017-12-22T08:00:00Z

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.

StartTime String Yes 2017-12-21T08:00:00Z

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.

AppName String No liveApp****

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

StreamName String No liveStream****

The name of the live stream.

PageSize Integer No 1500

The number of entries to return on each page. Valid values: 1 to 3000. Default value: 2000.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

StreamType String No all

The type of the streams whose pushing records are to be queried. Valid values:

  • all: all streams. This is the default value.
  • raw: original streams.
  • trans: transcoded streams.
QueryType String No fuzzy

The mode in which stream names are matched. Valid values:

  • fuzzy: fuzzy match. This is the default value.
  • strict: exact match.
OrderBy String No publish_time_desc

The method that is used to sort the entries. Valid values:

  • stream_name_desc: Sort the entries in descending order of live stream names.
  • stream_name_asc: Sort the entries in ascending order of live stream names.
  • publish_time_desc: Sort the entries in descending order of pushing time.
  • publish_time_asc: Sort the entries in ascending order of pushing time. This is the default value.

Response parameters

Parameter Type Example Description
PublishInfo Array of LiveStreamPublishInfo

The information about the stream pushing records.
LiveStreamPublishInfo
DomainName String example.com

The main streaming domain or ingest domain.
AppName String liveApp****

The name of the application to which the live stream belongs.
StreamName String iveStream****

The name of the live stream.

StreamUrl String http://example.com/liveApp****/liveStream****.flv

The URL of the live stream.

PublishTime String 2015-12-02T03:05:53Z

The time when stream pushing started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

StopTime String 2015-12-02T03:11:19Z

The time when stream pushing stopped. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

ClientAddr String 10.175.XX.XX

The IP address of the client that pushed the live stream.

EdgeNodeAddr String 10.175.XX.XX

The IP address of the Alibaba Cloud Content Delivery Network (CDN) node to which the live stream was pushed.

PublishUrl String rtmp://demo.aliyundoc.com/liveApp****/liveStream****

The complete URL that was used to push the live stream.

PublishDomain String demo.aliyundoc.com

The ingest domain.

PublishType String edge

The type of the stream pushing. Valid values:

  • edge: edge pushing.
  • center: live center pushing.
TranscodeId String ld

The ID of the transcoding template. This parameter is returned only when the live stream was transcoded.

Transcoded String yes

Indicates whether the live stream was transcoded.

PageNum Integer 2

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 40A4F36D-A7CC-473A-88E7-154F92242566

The ID of the request.

TotalNum Integer 11

The total number of stream pushing records that meet the specified conditions.

TotalPage Integer 2

The total number of pages returned.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsPublishList
&DomainName=example.aliyundoc.com
&EndTime=2017-12-22T08:00:00Z
&StartTime=2017-12-21T08:00:00Z
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

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

Error codes

HttpCode Error code Error message Description
400 InvalidStartTime.Malformed Specified parameter StartTime is not valid. The error message returned because the format of the start time is invalid. Check whether the value of the StartTime parameter is valid.
400 InvalidEndTime.Malformed Specified parameter EndTime is not valid. The error message returned because the format of the end time is invalid. Check whether the value of the EndTime parameter is valid.

For a list of error codes, visit the API Error Center.