DescribeLiveSnapshotData - 查询直播域名截图张数--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveSnapshotData - 查询直播域名截图张数

最近更新时间：2024.12.09 11:16:50首次发布时间：2023.09.25 14:35:35

调用 DescribeLiveSnapshotData 接口，查询指定时间范围内直播域名使用截图功能产生的截图张数。

注意事项

计费说明：截图价格请参见截图计费。
使用限制：支持查询已删除域名产生的所有直播截图任务的截图张数。
请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：数据延迟为 15 分钟。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=DescribeLiveSnapshotData&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeLiveSnapshotData`	接口名称。当前 API 的名称为 `DescribeLiveSnapshotData`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["push.example.com","push2.example.com"]`	域名列表，默认为空，表示查询您视频直播产品下所有域名的截图用量数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的域名。
StartTime	String	是	`2022-03-07T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	是	`2022-03-08T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	否	`86400`	数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。 `300`：5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天； `86400`：（默认值）1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
DetailField	Array of String	否	`["Domain"]`	数据拆分的维度，默认为空表示不按维度进行数据拆分，当前接口仅支持填写 `Domain` 表示按查询的域名为维度进行数据拆分。说明配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
App	String	否	`live`	应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。说明查询流粒度数据时，需同时传入 `App` 和 `Stream`。
Stream	String	否	`example_stream`	流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。说明查询流粒度数据时，需同时传入 `App` 和 `Stream`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
DomainList	Array of String	`["push.example.com","push.example.com"]`	域名列表。
StartTime	String	`2022-03-07T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2022-03-08T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`86400`	数据聚合的时间粒度，单位为秒。 `300`：5 分钟； `3600`：1 小时； `86400`：1 天。
DetailField	Array of String	`["Domain"]`	数据拆分的维度，当前接口仅支持按 Domain 即域名维度进行数据拆分。
Total	Integer	`19503380`	当前查询条件下的截图总张数。
SnapshotDataList	Array of SnapshotDataList	`-`	所有时间粒度的数据。
SnapshotDetailData	Array of SnapshotDetailData	`-`	按维度拆分后的数据。
App	String	`live`	查询流粒度数据时的应用名称。
Stream	String	`example_stream`	查询流粒度数据时的流名称。

SnapshotDataList

参数	类型	示例值	描述
TimeStamp	String	`2022-03-07T00:00:00+08:00`	数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
Value	Integer	`9503380`	当前数据聚合时间粒度内的截图总张数。

SnapshotDetailData

参数	类型	示例值	描述
Domain	String	`push.example.com`	按域名维度进行数据拆分时的域名信息。
Total	Integer	`19503380`	按维度进行数据拆分后，当前维度的截图总张数。
SnapshotDataList	Array of SnapshotDataList	`-`	按维度进行数据拆分后，当前维度下所有时间粒度的数据。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveSnapshotData&Version=2023-01-01
{
    "DomainList": [
        "push.example.com",
        "push2.example.com"
    ],
    "StartTime": "2022-03-07T00:00:00+08:00",
    "EndTime": "2022-03-08T00:00:00+08:00",
    "Aggregation": 86400,
    "DetailField": [
        "Domain"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeLiveSnapshotData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
    "DomainList": [
        "push.example.com",
        "push2.example2.com"
    ],
    "StartTime": "2022-03-07T00:00:00+08:00",
    "EndTime": "2022-03-08T00:00:00+08:00",
    "Aggregation": 86400,
    "DetailField": [
        "Domain"
    ],
        "Total": 19503380,
        "SnapshotDataList": [
            {
                "TimeStamp": "2022-03-07T00:00:00+08:00",
                "Value": 9503380
            },
            {
                "TimeStamp": "2022-03-08T00:00:00+08:00",
                "Value": 9507820
            }
        ],
        "SnapshotDetailData": [
            {
                "Domain": "push.example.com",
                "Total": 19503380,
                "SnapshotDataList": [
                    {
                        "TimeStamp": "2022-03-07T00:00:00+08:00",
                        "Value": 9503380
                    },
                    {
                        "TimeStamp": "2022-03-08T00:00:00+08:00",
                        "Value": 9507820
                    }
                ]
            },
            {
                "Domain": "push2.example.com",
                "Total": 19503380,
                "SnapshotDataList": [
                    {
                        "TimeStamp": "2022-03-07T00:00:00+08:00",
                        "Value": 9503380
                    },
                    {
                        "TimeStamp": "2022-03-08T00:00:00+08:00",
                        "Value": 9507820
                    }
                ]
            }
        ]
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。