查询SSAI用量信息

最近更新时间:2026-04-08 02:23:35

我的收藏

1. 接口描述

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

SSAI广告替换用量查询

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeStreamPackageSSAIUsage。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-shanghai 。
StartTime String 起始时间
示例值:2026-02-10T00+08:00
EndTime String 结束时间
示例值:2026-02-10T02+08:00
ChannelIds.N Array of String 需要查询的channel_id
示例值:["698AAD421D3EA5656115"]
Types.N Array of String 需要查询的广告类型。可选Pre-roll/Mid-roll/VOD;若为空,默认查询所有类型
示例值:["Pre-roll"]
Dimension Boolean 维度,可选值:summary对应false;detail 对应true
示例值:true

3. 输出参数

参数名称 类型 描述
Info SSAIUsageInfo SSAI用量信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用示例

查询SSAI用量

输入示例

POST / HTTP/1.1
Host: mdp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStreamPackageSSAIUsage
<公共请求参数>

{
    "StartTime": "2025-05-01T00+08:00",
    "EndTime": "2025-05-01T10+08:00"
}

输出示例

{
    "Response": {
        "Info": {
            "AdRequestSuccess": 1,
            "AdRequestFail": 0,
            "Impression": 0,
            "AdMarkerTime": 0,
            "ReplacedTime": 0,
            "MidFillRate": 0,
            "PreReqNum": 1,
            "PreReplacedNum": 0,
            "PreReplaceRate": 0,
            "UsageDetails": [
                {
                    "UniqId": "018f141593c91ea540e603706c52",
                    "ChannelId": "66503E8E0000930000F9",
                    "ChannelName": "ssai_channel",
                    "AdType": "Preroll",
                    "AdRequestSuccess": 1,
                    "AdRequestFail": 0,
                    "Impression": 0,
                    "Start": 0,
                    "FirstQuarter": 0,
                    "Midpoint": 0,
                    "ThirdQuarter": 0,
                    "Complete": 0,
                    "AdMarkerTime": 0,
                    "ReplacedTime": 0,
                    "MidFillRate": 0,
                    "PreReqNum": 1,
                    "PreReplacedNum": 0,
                    "PreReplaceRate": 0
                }
            ]
        },
        "RequestId": "req-xxx123"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.GetSSAIChannelsFailed InternalError.GetSSAIChannelsFailed
InternalError.GetSSAIUsagePartialFailed InternalError.GetSSAIUsagePartialFailed
InvalidParameter.InvalidParameterChannelId InvalidParameter.InvalidParameterChannelId
InvalidParameter.Type InvalidParameter.Type