DescribeLiveStreamState

Last updated: 2021-11-10 17:41:51

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to get the stream status, such as active, inactive, or disabled.
Note: this API is used to query the stream status, and should not be relied too much upon in important business scenarios.

Notes:

  1. You should not rely on the results returned by this API to initiate/interrupt live streams.
  2. The application can get and store the status of live rooms via Stream Push and Interruption Event Notification.
  3. You can use the DescribeLiveStreamOnlineList API to regularly (with the interval larger than 1 minute) check the status of live rooms monitored by the application.
  4. If you find that a stream is inactive using the stream status query API, you can use other above-mentioned methods to check its status.
  5. If access or resolution errors occur when you use the API to query, you can regard the stream as active, and do not perform operations on the application.

A maximum of 300 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeLiveStreamState.
Version Yes String Common parameter. The value used for this API: 2018-08-01.
Region No String Common parameter. This parameter is not required for this API.
AppName Yes String Push path, which is the same as the AppName in push and playback addresses and is "live" by default.
DomainName Yes String Your push domain name.
StreamName Yes String Stream name.

3. Output Parameters

Parameter Name Type Description
StreamState String Stream status,
active: active
inactive: Inactive
forbid: forbidden.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://live.tencentcloudapi.com/?Action=DescribeLiveStreamState
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&StreamName=stream1
&<Common request parameters>

Output Example

{
  "Response": {
    "StreamState": "active",
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.CallOtherSvrFailed Failed to call the internal service.
InternalError Internal error.
InternalError.CallOtherSvrError Error calling internal service.
InternalError.ConfigNotExist The configuration does not exist.
InternalError.GetBizidError Error getting user account.
InternalError.GetStreamInfoError Failed to get the stream information.
InternalError.GetUpstreamInfoError Error getting the live stream source information.
InternalError.NotPermmitOperat No permission to operate.
InternalError.StreamStatusError Exceptional stream status.
InternalError.UpdateDataError Failed to update data.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
MissingParameter Parameter missing.
ResourceNotFound.UserNotExist The LVB service has not been activated.