- Introduction
- Purchase Guide
- Console Guide
- Feature Guide
- API Documentation
- StreamLive Policy
- Related Agreement
- Introduction
- Purchase Guide
- Console Guide
- Feature Guide
- API Documentation
- StreamLive Policy
- Related Agreement
1. API Description
Domain name for API request: mdl.tencentcloudapi.com.
This API is used to query the alarm information of a StreamLive channel.
A maximum of 20 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 Params. The value used for this API: DescribeStreamLiveChannelAlerts. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-26. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ChannelId | Yes | String | Channel ID |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Infos | ChannelAlertInfos | Alarm information of the channel’s two pipelines |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Sample request
Input Example
https://mdl.tencentcloudapi.com/?Action=DescribeStreamLiveChannelAlerts
&ChannelId=1111
&<Common request parameters>
Output Example
{
"Response": {
"Infos": {
"Pipeline0": [
{
"SetTime": "2020-03-30T07:04:08Z",
"ClearTime": "2020-03-30T08:04:08Z",
"Type": "RTMP Stream Not Found",
"Message": "Searching for RTMP Push stream [testStream], which does not exist at this time"
}
],
"Pipeline1": [
{
"SetTime": "2020-03-30T07:04:08Z",
"ClearTime": "2020-03-30T08:04:08Z",
"Type": "Failed to Write to Output",
"Message": "Failed to send file for URL [http://www.domain2.com/live/index.m3u8], after [3] attempts, error [http client error [405]]"
}
]
},
"RequestId": "11-222-222"
}
}
5. Developer Resources
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 Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter.NotFound | Not found. |
Yes
No
Was this page helpful?