DescribeLiveStreamState
Last updated: 2019-06-25 22:24:45
Contents：
## 1. API Description
API request domain name: live.tencentcloudapi.com.
This API returns the status of the stream such as active, inactive or prohibited.
Default API request rate limit: 1000 requests/second.
2. Request Parameters
The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.
| Parameter name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter; the name of this API: DescribeLiveStreamState |
| Version | Yes | String | Common parameter; the version of this API: 2018-08-01 |
| Region | No | String | Common parameter; optional for this API |
| AppName | Yes | String | Application name |
| DomainName | Yes | String | Your upstream domain name |
| StreamName | Yes | String | Stream name |
3. Return Parameters
| Parameter name | Type | Description |
|---|---|---|
| StreamState | String | Stream status. active: active, inactive: inactive, forbid: forbidden |
| RequestId | String | The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues. |
4. Sample
Request Sample
Input Sample Code
https://live.tencentcloudapi.com/?Action=DescribeLiveStreamState
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&StreamName=stream1
&<Common request parameter>Output Sample Code
{
"Response": {
"StreamState": "active",
"RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
}
}5. Developer Resources
API Explorer
API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.
SDK
Cloud API 3.0 comes with a set of complementary development toolkits (SDKs) that support multiple programming languages and make it easier to call the API.
- 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
TCCLI
6. Error Codes
The following error codes are API business logic-related. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| 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 stream information. |
| InternalError.GetUpstreamInfoError | Error getting live stream source information. |
| InternalError.NotPermmitOperat | No permission to operate. |
| InternalError.StreamStatusError | Exceptional stream status. |
| InternalError.UpdateDataError | Failed to update data. |
| InvalidParameter | Parameter error |
| InvalidParameterValue | Incorrect parameter value |
| MissingParameter | Missing parameter |
