Queries the stream ingest records of a domain name or an application or stream under a domain name.
Usage notes
This operation allows you to query streams over the last 30 days. The information of active streams during the queried period is returned. This operation supports the following sorting methods.
- stream_name_desc: Sort the entries in descending order by live stream name.
- stream_name_asc: Sort the entries in ascending order by live stream name.
- publish_time_desc: Sort the entries in descending order by stream ingest time.
- publish_time_asc: Sort the entries in ascending order by stream ingest time.
QPS limit
You can call this operation up to 3 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeLiveStreamsPublishList |
The operation that you want to perform. Set the value to DescribeLiveStreamsPublishList. |
RegionId | String | No | cn-shanghai |
The ID of the region where the domain name resides. |
DomainName | String | Yes | example.com |
The ingest domain or main streaming domain. |
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. |
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. |
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. |
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 to query. Valid values:
|
QueryType | String | No | fuzzy |
The mode in which stream names are matched. Valid values:
|
OrderBy | String | No | publish_time_desc |
The sorting method. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
TotalPage | Integer | 2 |
The total number of returned pages. |
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 streams that meet the specified conditions. |
PublishInfo | Array of LiveStreamPublishInfo |
The information about the stream ingest records. |
|
LiveStreamPublishInfo | |||
EdgeNodeAddr | String | 10.175.XX.XX |
The IP address of the Alibaba Cloud CDN node to which the stream was ingested. |
PublishUrl | String | rtmp://demo.aliyundoc.com/liveApp****/liveStream**** |
The complete URL that was used to ingest the stream. |
StreamName | String | liveStream**** |
The name of the live stream. |
DomainName | String | example.com |
The ingest domain or main streaming domain. |
StopTime | String | 2015-12-02T03:11:19Z |
The time when the stream ingest was stopped. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
TranscodeId | String | ld |
The ID of the transcoding template. This parameter is returned only when the stream was transcoded. |
PublishDomain | String | demo.aliyundoc.com |
The ingest domain. |
AppName | String | liveApp**** |
The name of the application to which the live stream belongs. |
PublishTime | String | 2015-12-02T03:05:53Z |
The time when the stream started to be ingested. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
PublishType | String | edge |
The type of the stream ingest. Valid values:
|
Transcoded | String | yes |
Indicates whether the stream was transcoded. |
ClientAddr | String | 10.175.XX.XX |
The IP address of the client that ingested the live stream. |
StreamUrl | String | http://example.com/liveApp****/liveStream****.flv |
The URL of the live stream. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsPublishList
&DomainName=example.com
&EndTime=2017-12-22T08:00:00Z
&StartTime=2017-12-21T08:00:00Z
&<Common request parameters>
Sample success response
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<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
HTTP/1.1 200 OK
Content-Type:application/json
{
"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.