Queries the stream ingest records of a domain name or an application or stream under a domain name.
Operation description
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
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
live:DescribeLiveStreamsPublishList | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainName | string | Yes | The ingest domain or main streaming domain. | example.com |
AppName | string | No | The name of the application to which the live stream belongs. | liveApp**** |
StreamName | string | No | The name of the live stream. | 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 to return on each page. Valid values: 1 to 3000. Default value: 2000. | 1500 |
PageNumber | integer | No | The number of the page to return. Default value: 1. | 1 |
StreamType | string | No | The type of the streams to query. Valid values:
| all |
QueryType | string | No | The mode in which stream names are matched. Valid values:
| fuzzy |
OrderBy | string | No | The sorting method. Valid values:
| publish_time_desc |
Response parameters
Examples
Sample success responses
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"
}
]
}
}
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. | - |
For a list of error codes, visit the Service error codes.