DescribeMediaProcessUsageData

Last updated: 2020-11-24 18:53:43

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 parameter. The value used for this API: DescribeMediaProcessUsageData.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
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.
Type No String This API is used to query video processing task types. The following types are supported now:
  • Transcoding: Basic transcoding
  • Transcoding-TESHD: TESHD transcoding
  • Editing: Video editing
  • AdaptiveBitrateStreaming: adaptive bitrate streaming
  • ContentAudit: content audit
  • Transcode: transcoding types, including basic transcoding, TESHD transcoding and video editing (not recommended)
  • SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

    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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying resource usage of video processing

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeMediaProcessUsageData
    &StartTime=2020-09-07T00:00:00+08:00
    &EndTime=2020-09-09T23:59:59+08:00
    &Type=Transcoding-TESHD
    &<Public request parameters>

    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,
                    "Count": 2,
                }, {
                    "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.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.

    Was this page helpful?

    Was this page helpful?

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