tencent cloud

APIs

DescribeMediaProcessUsageData

Download
Focus Mode
Font Size
Last updated: 2026-09-22 21:56:05

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to return the daily video processing usage information within the specified query time range.

  1. Video processing usage data is retained for 13 months in the data system. You can only query usage data from the most recent 365 days through the interface. To retrieve historical usage data beyond 365 days, contact us.
    1. The query time span should not exceed 90 days.

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: DescribeMediaProcessUsageData.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
StartTime Yes String Start date. Use the ISO date format.
EndTime Yes String End date, which should be greater than or equal to the start date. Use the ISO date format.
SubAppId No Integer VOD application ID. For customers who activate VOD services after December 25, 2023, when accessing resources in VOD applications (whether the default application or a newly created application), this field must be set to the app ID.
Type No String Query video processing task type. Currently supported task types include:
  • Transcoding: standard transcoding.
  • Transcoding-TESHD: TSC transcoding.
  • Editing: video editing
  • Editing-TESHD: extremely fast high-definition video editing
  • AdaptiveBitrateStreaming: adaptive bitrate streaming.
  • ContentAudit: content moderation.
  • ContentRecognition: content recognition.
  • RemoveWatermark: remove watermark
  • ExtractTraceWatermark: extract watermark
  • AddTraceWatermark: Add watermark
  • RebuildMedia: audio and video quality revival
  • QualityInspect: audio and video quality inspection
  • VideoHighlight: video intelligent highlights
  • VideoTag: video intelligent tag
  • VideoClassification: video intelligent classification
  • VideoCover: video intelligent cover.
  • VideoSegment: video intelligent splitting.
  • VideoProduce: video production
  • MediaCast: media forwarding.
  • Transcode: Transcoding, including standard transcoding, top speed Codec, and video editing (not recommend)
  • VoiceTranslation: speech translation
  • JITTranscoding: JIT transcoding
  • VideoSnapshot: video screenshot.
  • JITEncryption: real-time encryption
  • MediaEnhancement: audio and video enhancement
  • ImageCompression: image compression
  • ImageEnhancement: image enhancement.
  • ImageSuperResolution: image super resolution.
  • ImageAdvanceCompression: image advanced compression.
  • ImageUnderstanding: image understanding.
  • AddTraceWatermark: Add traceability watermark
  • AddBlindWatermark: Add blind watermark
  • AddNagraWatermark: Add NAGRA digital watermark
  • ExtractTraceWatermark: extract traceability watermark.
  • ExtractBlindWatermark: extract a blind watermark.
  • ExtractNagraWatermark: Extract NAGRA digital watermark

  • 3. Output Parameters

    Parameter Name Type Description
    MediaProcessDataSet Array of TaskStatData Video processing statistics overview, which displays an overview and detailed data of the queried task.
    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 Query video processing usage

    Query video processing usage

    Input Example

    POST / HTTP/1.1
    Host: vod.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeMediaProcessUsageData
    <Common request parameters>
    
    {
        "EndTime": "2020-09-09T23:59:59+08:00",
        "Type": "Transcoding-TESHD",
        "StartTime": "2020-09-07T00:00:00+08:00"
    }

    Output Example

    {
        "Response": {
            "MediaProcessDataSet": [
                {
                    "TaskType": "Transcoding-TESHD",
                    "Summary": [
                        {
                            "Time": "2020-09-07T00:00:00+08:00",
                            "Count": 2,
                            "Usage": 26
                        },
                        {
                            "Time": "2020-09-08T00:00:00+08:00",
                            "Count": 2,
                            "Usage": 168
                        },
                        {
                            "Time": "2020-09-09T00:00:00+08:00",
                            "Count": 2,
                            "Usage": 26
                        }
                    ],
                    "Details": [
                        {
                            "Specification": "TESHD-10.H264.SD",
                            "Data": [
                                {
                                    "Time": "2020-09-07T00:00:00+08:00",
                                    "Count": 2,
                                    "Usage": 26
                                },
                                {
                                    "Time": "2020-09-08T00:00:00+08:00",
                                    "Count": 1,
                                    "Usage": 84
                                },
                                {
                                    "Time": "2020-09-09T00:00:00+08:00",
                                    "Count": 2,
                                    "Usage": 26
                                }
                            ]
                        },
                        {
                            "Specification": "TESHD-10.H264.HD",
                            "Data": [
                                {
                                    "Time": "2020-09-07T00:00:00+08:00",
                                    "Count": 0,
                                    "Usage": 0
                                },
                                {
                                    "Time": "2020-09-08T00:00:00+08:00",
                                    "Count": 1,
                                    "Usage": 84
                                },
                                {
                                    "Time": "2020-09-09T00:00:00+08:00",
                                    "Count": 0,
                                    "Usage": 0
                                }
                            ]
                        }
                    ]
                }
            ],
            "RequestId": "requestId"
        }
    }

    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.InvalidVodUser VOD service is not enabled.
    InternalError Internal error.
    InvalidParameterValue Parameter value error.

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback