DescribeLiveStreamsControlHistory - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

The operations include all API operations that were called on live streams.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveStreamsControlHistory

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The main streaming domain.	example.com
AppName	string	No	The application name. View AppName on the Stream Management page.	liveApp****
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. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The interval between EndTime and StartTime cannot exceed 7 days.	2017-12-22T08:00:00Z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9C31856F-386D-4DB3-BE79-A0AA493D702A
ControlInfo	object
LiveStreamControlInfo	array<object>	The operation records.
	object	The operation records.
ClientIP	string	The client IP address.	10.207.XX.XX
TimeStamp	string	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
Action	string	The name of the operation performed.	DescribeLiveStreamsControlHistory
StreamName	string	The name of the live stream.	liveStream****

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
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	InvalidParam	Parameter invalid.	Illegal input parameters
500	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.