DescribeLiveStreamState
Last updated: 2020-01-13 15:38:34
Contents：
1. API Description
Domain name for API request: live.tencentcloudapi.com.
This API is used to return the stream status such as active, inactive, or forbidden.
A maximum of 1000 requests can be initiated per second for this API.
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 Request Sample
Input Example
https://live.tencentcloudapi.com/?Action=DescribeLiveStreamState
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&StreamName=stream1
&<Common request parameter>Output Example
{
"Response": {
"StreamState": "active",
"RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
}
}5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
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 | Wrong parameter value. |
| MissingParameter | Missing parameter. |
| ResourceNotFound.UserNotExist | The LVB service has not been activated. |
