DescribeMediaLiveChannelOutputStatistics

Last updated: 2020-07-31 14:20:19

1. API Description

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

This API is used to query the output statistics of a 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 parameter. The value used for this API: DescribeMediaLiveChannelOutputStatistics.
Version Yes String Common parameter. The value used for this API: 2020-03-26.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ChannelId Yes String Channel ID.
StartTime No String Statistics start time, which is one hour ago by default. Maximum value: the last 7 days.
UTC time, such as 2020-01-01T12:00:00Z.
EndTime No String Statistics end time, which is one hour after StartTime by default.
UTC time, such as 2020-01-01T12:00:00Z.
Period No String Data interval. Valid values: 5s, 1min, 5min, 15min. Default value: 1min.

3. Output Parameters

Parameter Name Type Description
Infos Array of ChannelOutputsStatistics Channel output information.
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://mdl.tencentcloudapi.com/?Action=DescribeMediaLiveChannelOutputStatistics
&ChannelId=AEAE83719CE
&StartTime=2020-01-01T12:00:00Z
&EndTime=2020-01-01T14:00:00Z
&<Common request parameters>

Output Example

{
  "Response": {
    "Infos": [
      {
        "OutputGroupName": "TEST",
        "Statistics": {
          "Pipeline0": [
            {
              "Timestamp": 1585554600,
              "NetworkOut": 2000000
            }
          ],
          "Pipeline1": [
            {
              "Timestamp": 1585554600,
              "NetworkOut": 2000000
            }
          ]
        }
      }
    ],
    "RequestId": "11-222-222"
  }
}

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.

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.EndTime Invalid EndTime.
InvalidParameter.Id Invalid Id.
InvalidParameter.NotFound Not found.
InvalidParameter.StartTime Invalid StartTime.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help