DescribeLiveStreamsPublishList - API Reference| Alibaba Cloud Documentation Center

Note

This operation can be called up to three times per second.
You can query the stream pushing records of the last 30 days at most.

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	play.yourdomain.com	The main streaming domain and 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	testApp	The name of the application to which the live stream belongs.
StreamName	String	No	testStream	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	play.yourdomain.com	The main streaming domain and ingest domain.
AppName	String	AppName	The name of the application to which the live stream belongs.
StreamName	String	StreamName	The name of the live stream.
StreamUrl	String	http://play.aliyunlive.com/AppName/StreamName.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.60.33	The IP address of the client that pushed the live stream.
EdgeNodeAddr	String	10.175.30.21	The IP address of the Alibaba Cloud Content Delivery Network (CDN) node to which the live stream was pushed.
PublishUrl	String	rtmp://push.aliyunlive.com/AppName/StreamName	The complete URL that was used to push the live stream.
PublishDomain	String	play.yourdomain.com	The pushing 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=play.yourdomain.com
&EndTime=2017-12-22T08:00:00Z
&StartTime=2017-12-21T08:00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeLiveStreamsPublishListResponse>
      <PageNum>2</PageNum>
      <PageSize>10</PageSize>
      <PublishInfo>
            <LiveStreamPublishInfo>
                  <AppName>xchen</AppName>
                  <ClientAddr>10.175.60.33</ClientAddr>
                  <DomainName>test101.cdnpe.com</DomainName>
                  <EdgeNodeAddr>10.175.30.21</EdgeNodeAddr>
                  <PublishDomain>test101.cdnpe.com</PublishDomain>
                  <PublishTime>2015-12-02T03:05:53Z</PublishTime>
                  <PublishUrl>rtmp://test101.cdnpe.com/xchen</PublishUrl>
                  <StopTime>2015-12-02T03:11:19Z</StopTime>
                  <StreamName>testxchen</StreamName>
                  <StreamUrl>http://play.aliyunlive.com/AppName/StreamName.flv</StreamUrl>
            </LiveStreamPublishInfo>
      </PublishInfo>
      <RequestId>1C0E0C22-77B7-42AC-8212-AF99B2E0077F</RequestId>
      <TotalNum>11</TotalNum>
      <TotalPage>2</TotalPage>
</DescribeLiveStreamsPublishListResponse>

JSON format

{
  "DescribeLiveStreamsPublishListResponse": {
    "PageNum": "2",
    "PageSize": "10",
    "PublishInfo": {
      "LiveStreamPublishInfo": {
        "AppName": "xchen",
        "ClientAddr": "10.175.60.33",
        "DomainName": "test101.cdnpe.com",
        "EdgeNodeAddr": "10.175.30.21",
        "PublishDomain": "test101.cdnpe.com",
        "PublishTime": "2015-12-02T03:05:53Z",
        "PublishUrl": "rtmp://test101.cdnpe.com/xchen",
        "StopTime": "2015-12-02T03:11:19Z",
        "StreamName": "testxchen",
        "StreamUrl": "http://play.aliyunlive.com/AppName/StreamName.flv"
      }
    },
    "RequestId": "1C0E0C22-77B7-42AC-8212-AF99B2E0077F",
    "TotalNum": "11",
    "TotalPage": "2"
  }
}

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.