DescribeLiveStreamState - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Obtain a live streaming domain name. Then, call this operation to query the real-time state of a single stream. For detailed information about the offline state, retrieve the data returned by the stream ingest callback because this operation does not provide a breakdown of offline states.

QPS limit

The queries per second (QPS) limit for a single user on this operation is 100 calls/second. If the limit is exceeded, API calls are throttled, which may affect your business. Plan your calls accordingly.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes		demo.aliyundoc.com
AppName	string	Yes	The ingest domain or the streaming domain.	liveApp****
StreamName	string	Yes	The name of the application that hosts the live stream. You can find the AppName on the Stream Management page.	liveStream****

Response elements

Element	Type	Description	Example
	object
Type	string	The type of the ingest endpoint. Valid values: push: stream ingest. pull: triggered stream pulling.	push
RequestId	string	The request ID.	CE6CD79D-0A98-1F22-A15F-FADA74DF2729
StreamState	string	The state of the stream. Valid values: online: The stream is being ingested. offline: The stream is inactive. This can mean the stream ingest failed or has ended. This operation does not provide specific reasons for the offline state. For details, check the data returned by the stream ingest callback.	online

Examples

Success response

JSON format

{
  "Type": "push",
  "RequestId": "CE6CD79D-0A98-1F22-A15F-FADA74DF2729",
  "StreamState": "online"
}

Error codes

HTTP status code	Error code	Error message	Description
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.