Queries the status of a single live stream in real time.

Usage note

This operation supports querying the status of a live stream by the name of the live stream. If the stream is in offline status, please check the details in the response.

QPS limit

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

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

AppName String Yes liveApp****

The name of the application to which the live stream belongs.
DomainName String Yes demo.aliyundoc.com

The ingest domain or streaming domain.

StreamName String Yes liveStream****

The name of the live stream.

RegionId String No cn-shanghai

The ID of the region.

Response parameters

Parameter Type Example Description
RequestId String CE6CD79D-0A98-1F22-A15F-FADA74DF2729

The ID of the request.

StreamState String online

The status of the stream. Valid values:

  • online: indicates that the stream is being ingested.
  • offline: indicates that stream ingest failed or ended. The specific status is returned based on the stream ingest callback.
  • forbidden: indicates that stream ingest is disabled.
Type String push

The type of stream ingest. Valid values:

  • push: stream pushing.
  • pull: triggered stream pulling.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamState
&AppName=liveApp****
&DomainName=demo.aliyundoc.com
&StreamName=liveStream****
&<Common request parameters>

Sample success responses

XML format 

<DescribeLiveStreamStateResponse>
  <StreamState>online</StreamState>
  <Type>push</Type>
  <RequestId>CE6CD79D-0A98-1F22-A15F-FADA74DF2729</RequestId>
</DescribeLiveStreamStateResponse>

JSON format 

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

Error codes

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