tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeQualityControlTemplates

Last updated: 2024-11-07 11:23:51

1. API Description

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

This API is used to query custom media quality inspection templates, supporting paged queries by conditions.

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: DescribeQualityControlTemplates.
Version Yes String Common Params. The value used for this API: 2019-06-12.
Region No String Common Params. This parameter is not required for this API.
Definitions.N No Array of Integer Filter condition for media quality inspection template unique identifiers, with an array length limit of 100.
Offset No Integer Paging offset. Default value: 0.
Limit No Integer Number of returned entries.

  • Default value: 10.
  • Maximum value: 100.
    		•
    Type No String "Preset": preset template, "Custom": custom template
    Name No String Filter condition for media quality inspection template identifiers, with a length limit of 64 characters.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of records that meet filter conditions.
    QualityControlTemplateSet Array of QualityControlTemplate Media quality inspection template details list.
    Note: This field may return null, indicating that no valid values can be obtained.
    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 a List of Media Quality Inspection Templates

    Input Example

    POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeQualityControlTemplates
<Common request parameters>



{
    "Offset": 0,
    "Limit": 10,
    "Definitions": [
        200058
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "QualityControlTemplateSet": [
            {
                "Definition": 200058,
                "Name": "0529",
                "Comment": "",
                "Type": "Custom",
                "QualityControlItemSet": [
                    {
                        "Type": "LowEvaluation",
                        "Switch": "ON",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "Mosaic",
                        "Switch": "ON",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "CrashScreen",
                        "Switch": "ON",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "Blur",
                        "Switch": "ON",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "BlackWhiteEdge",
                        "Switch": "ON",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "LowLighting",
                        "Switch": "ON",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HighLighting",
                        "Switch": "ON",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "NoVoice",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "LowVoice",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HighVoice",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "VideoResolutionChanged",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AudioSampleRateChanged",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AudioChannelsChanged",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "ParameterSetsChanged",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "DarOrSarInvalid",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "TimestampFallback",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "DtsJitter",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "PtsJitter",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AACDurationDeviation",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AudioDroppingFrames",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "VideoDroppingFrames",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AVTimestampInterleave",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "PtsLessThanDts",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "ReceiveFpsJitter",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "ReceiveFpsTooSmall",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "FpsJitter",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "StreamOpenFailed",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "StreamEnd",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "StreamParseFailed",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "VideoFirstFrameNotIdr",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "StreamNALUError",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "TsStreamNoAud",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AudioStreamLack",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "VideoStreamLack",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "LackAudioRecover",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "LackVideoRecover",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "VideoBitrateOutofRange",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AudioBitrateOutofRange",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "VideoDecodeFailed",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AudioDecodeFailed",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AudioOutOfPhase",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "VideoDuplicatedFrame",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "AudioDuplicatedFrame",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "VideoRotation",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "TsMultiPrograms",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "Mp4InvalidCodecFourcc",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HLSBadM3u8Format",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HLSInvalidMasterM3u8",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HLSInvalidMediaM3u8",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HLSMasterM3u8Recommended",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HLSMediaM3u8Recommended",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HLSMediaM3u8DiscontinuityExist",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HLSMediaSegmentsStreamNumChange",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HLSMediaSegmentsPTSJitterDeviation",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "HLSMediaSegmentsDTSJitterDeviation",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "TimecodeTrackExist",
                        "Switch": "OFF",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 0,
                        "Threshold": ""
                    },
                    {
                        "Type": "VideoFreezedFrame",
                        "Switch": "ON",
                        "Sampling": "",
                        "IntervalTime": 0,
                        "Duration": 1000,
                        "Threshold": "0.001"
                    }
                ],
                "CreateTime": "2024-05-29T03:01:54Z",
                "UpdateTime": "2024-05-29T03:01:54Z"
            }
        ],
        "RequestId": "76d831ad-105e-48eb-90dd-00deaa00b52a"
    }
}

    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.InvalidMpsUser Operation failed: unauthorized MPS user.
    InternalError Internal error.
    InvalidParameterValue.Definitions Parameter error: Definitions.
    InvalidParameterValue.Limit Parameter error: Limit.
    InvalidParameterValue.Type Parameter error: incorrect Type value.
    ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy