All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamsControlHistory

Last Updated:Nov 14, 2024

Queries the operation history of live streams under a domain name or in an application.

Operation description

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveStreamsControlHistoryget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The main streaming domain.

example.com
AppNamestringNo

The name of the application.

liveApp****
StartTimestringYes

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
EndTimestringYes

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.

2017-12-22T08:00:00Z

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

9C31856F-386D-4DB3-BE79-A0AA493D702A
ControlInfoarray<object>

The operation record of the live stream.

LiveStreamControlInfoobject
ClientIPstring

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

10.207.XX.XX
TimeStampstring

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.

2015-12-01T16:36:18Z
Actionstring

The name of the operation performed.

DescribeLiveStreamsControlHistory
StreamNamestring

The name of the live stream.

liveStream****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedSpecified parameter StartTime is not valid.-
400InvalidEndTime.MalformedSpecified parameter EndTime is not valid.-
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The value specified for the StartTime parameter is invalid.
400InvalidParamParameter invalid.Illegal input parameters
500InternalErrorThe request processing has failed due to backend service exception.-

For a list of error codes, visit the Service error codes.