Queries the status of a stream in real time.
Operation description
Obtain the streaming domain, and then call this operation to query the status of a stream in real time. If the stream is in the offline status, you can check the stream ingest callback to learn about the reason that causes the offline status. This operation does not provide detailed information.
QPS limit
You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:DescribeLiveStreamState | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | The streaming domain or ingest domain. | demo.aliyundoc.com |
| AppName | string | Yes | The name of the application to which the live stream belongs. You can view the application name on the Stream Management page of the ApsaraVideo Live console. | liveApp**** |
| StreamName | string | Yes | The name of the live stream. You can view the stream name on the Stream Management page of the ApsaraVideo Live console. | liveStream**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. | - |
For a list of error codes, visit the Service error codes.