Queries the operation history of live streams under a main streaming domain or an application.

Usage note

Operation refers to the API operation performed on the live streams. You must specify the StartTime and EndTime in the request.

QPS limit

A single user can perform a maximum of 50 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 DescribeLiveStreamsControlHistory

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

DomainName String Yes example.com

The main streaming domain.
EndTime String Yes 2017-12-22T08:00:00Z

The end 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.

The maximum time range that can be specified is seven days.
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.

Response parameters

Parameter Type Example Description
ControlInfo Array of LiveStreamControlInfo

The operation history of live streams.
LiveStreamControlInfo
StreamName String liveStream****

The name of the live stream.
ClientIP String 10.207.XX.XX

The IP address that is used by the client for live streaming.
Action String DescribeLiveStreamsControlHistory

The name of the operation performed.
TimeStamp String 2015-12-01T16:36:18Z

The time when the operation was performed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

RequestId String 9C31856F-386D-4DB3-BE79-A0AA493D702A

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeLiveStreamsControlHistoryResponse>
  <RequestId>9C31856F-386D-4DB3-BE79-A0AA493D702A</RequestId>
  <ControlInfo>
        <LiveStreamControlInfo>
              <Action>DescribeLiveStreamsControlHistory</Action>
              <StreamName>liveStream****</StreamName>
              <ClientIP>10.207.XX.XX</ClientIP>
              <TimeStamp>2015-12-01T16:36:18Z</TimeStamp>
        </LiveStreamControlInfo>
  </ControlInfo>
</DescribeLiveStreamsControlHistoryResponse>

JSON format 

{
    "DescribeLiveStreamsControlHistoryResponse": {
        "RequestId": "9C31856F-386D-4DB3-BE79-A0AA493D702A",
        "ControlInfo": {
            "LiveStreamControlInfo": {
                "Action": "DescribeLiveStreamsControlHistory",
                "StreamName": "liveStream****",
                "ClientIP": "10.207.XX.XX",
                "TimeStamp": "2015-12-01T16:36:18Z"
            }
        }
    }
}

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 correct.
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 correct.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. The error message returned because the end time is earlier than the start time. Check whether the values of the StartTime and EndTime parameters are correct.

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