tencent cloud

Feedback

DescribeMediaProcessUsageData

Last updated: 2024-03-27 16:09:02

    1. API Description

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

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

    1. Statistics on video processing for the last 365 days can be queried.
    2. The query time range cannot be more than 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 in ISO date format.
    EndTime Yes String End date in ISO date format. The end date must be on or after the start date.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Type No String Query the video processing task type. Currently supported task types include:
  • Transcoding: Normal transcoding
  • Transcoding-TESHD: Extremely fast high-definition transcoding
  • Editing : Video editing
  • Editing-TESHD: Extremely fast high-definition video editing
  • AdaptiveBitrateStreaming: Adaptive bitrate streaming
  • ContentAudit: Content audit
  • li>
  • ContentRecognition: Content recognition
  • RemoveWatermark: Remove watermark
  • ExtractTraceWatermark: Extract watermark
  • AddTraceWatermark: Add watermark
  • RebuildMedia: Rebirth of audio and video quality
  • QualityInspect: Media quality inspection
  • VideoHighlight: Smart video collection

  • < li> VideoTag: Video smart tag
  • VideoClassification: Video smart classification
  • VideoCover: Video smart cover
  • VideoSegment: Video smart split
  • Transcode: transcoding, including normal transcoding, high-speed HD and video editing (not recommended)
  • 3. Output Parameters

    Parameter Name Type Description
    MediaProcessDataSet Array of TaskStatData Overview of video processing statistics, which displays the overview and details of queried tasks.
    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 Querying video processing usage

    This example shows you how to query video processing usage.

    Input Example

    POST / HTTP/1.1
    Host: vod.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 The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support