获取媒体质检模板列表

最近更新时间:2024-09-20 13:08:01

我的收藏

1. 接口描述

接口请求域名: mps.tencentcloudapi.com 。

查询用户自定义媒体质检模板,支持根据条件,分页查询。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeQualityControlTemplates。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
Definitions.N Array of Integer 媒体质检模板唯一标识过滤条件,数组长度限制:100。
示例值:["1001\n"]
Offset Integer 分页偏移量,默认值:0。
示例值:0
Limit Integer 返回记录条数
  • 默认值:10;
  • 最大值:100。

  • 示例值:20
    Type String "Preset":预设,Custom":自定义模板
    示例值:Preset
    Name String 媒体质检模板标识过滤条件,长度限制:64 个字符。
    示例值:“”

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    示例值:1
    QualityControlTemplateSet Array of QualityControlTemplate 媒体质检模板详情列表。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询媒体质检模板列表

    输入示例

    POST / HTTP/1.1
    Host: mps.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeQualityControlTemplates
    <公共请求参数>
    
    {
        "Offset": 0,
        "Limit": 10,
        "Definitions": [
            200058
        ]
    }

    输出示例

    {
        "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. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
    InternalError 内部错误。
    InvalidParameterValue.Definitions 参数错误:Definitions。
    InvalidParameterValue.Limit 参数错误:Limit。
    InvalidParameterValue.Type 参数错误:Type 参数值错误。
    ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。