DescribeToutiaoLivePlay - - Alibaba Cloud Documentation Center

Operation description

You can call this API to query stream pulling information for a specified Toutiao live stream.

QPS limits

The queries per second (QPS) limit for a single user is 100. If you exceed this limit, API calls are throttled. This may affect your business. For more information, see QPS limits.

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:DescribeToutiaoLivePlay

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
StartTime	string	Yes	The start of the time range to query. Specify the time in the ISO 8601 standard. Use UTC.	2017-10-10T20:00:00Z
EndTime	string	Yes	The end of the time range to query. The end time must be later than the start time, and the time span cannot exceed 10 hours. If you do not specify StartTime and EndTime, data for the last hour is queried by default. Specify the time in the ISO 8601 standard. Use UTC.	2017-10-10T21:00:00Z
Domain	string	Yes	The streaming domain.	example.com
Stream	string	Yes	The stream name.	liveStream****
App	string	Yes	The name of the application to which the stream belongs.	liveApp****

Response elements

Element	Type	Description	Example
	object
Description	string	The description of the response status.	OK
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F****
Content	array<object>	The details of the stream information.
	object	The details of the stream information.
Domain	string	The streaming domain.	example.com
Bandwidth	number	The bandwidth. Unit: Mbit/s.	0.0801239013671875
StreamName	string	The stream name.	liveStream****
App	string	The name of the application to which the stream belongs.	liveApp****
PlayNum	integer	The number of viewers.	452
Timestamp	integer	The timestamp.	1625484600
CdnName	string	The CDN name.	ali

Examples

Success response

JSON format

{
  "Description": "OK",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "Content": [
    {
      "Domain": "example.com",
      "Bandwidth": 0.0801239013671875,
      "StreamName": "liveStream****",
      "App": "liveApp****\n",
      "PlayNum": 452,
      "Timestamp": 1625484600,
      "CdnName": "ali"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.