You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询直播域名截图张数

最近更新时间：2023.11.13 19:57:29

首次发布时间：2023.09.25 14:35:35

我的收藏

支持查询用户直播截图计量数据。支持按照域名维度（含删除域名）查询，数据按天粒度聚合。

注意事项

  • 请求频率：单用户请求频率限制为 100 次/秒。
  • 数据延迟：数据延迟为 15 分钟。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainListArray of String否["example.com","example2.com"]域名列表，缺省情况表示该用户的所有域名。
StartTimeString是2022-03-07T00:00:00+08:00查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s。
EndTimeString是2022-03-08T00:00:00+08:00查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s。

Aggregation

Integer

否

86400

时间粒度，单位为 s，默认值为 86400。支持如下时间粒度。

  • 300：支持单次查询时间跨度为 31 天，历史查询时间范围为 93 天；
  • 3600：支持单次查询时间跨度为 93 天，历史查询时间范围为 93 天；
  • 86400：支持单次查询时间跨度为 93 天，历史查询时间范围为 366 天。
DetailFieldArray of String否["Domain"]数据拆分的维度，可取值为 Domain，设置为空时不进行数据拆分。
AppString否example_app应用名称。
StreamString否example_stream流名称。

返回参数

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

参数类型示例值描述
DomainListArray of String["example.com","example2.com"]域名列表。
StartTimeString2022-03-07T00:00:00+08:00查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s。
EndTimeString2022-03-08T00:00:00+08:00查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s。
AggregationInteger86400时间粒度，单位为 s。
DetailFieldArray of String["Domain"]数据拆分的维度。
TotalInteger19503380所选域名的截图总张数。
SnapshotDataListArray of SnapshotDataList-每个聚合时间片的截图张数详情。
SnapshotDetailDataArray of SnapshotDetailData-按维度拆分后的详细数据。
AppStringexample_app应用名称。
StreamStringexample_stream流名称。

SnapshotDataList

参数类型示例值描述
TimeStampString2022-03-07T00:00:00+08:00时间片起始时刻。RFC3339 格式的 UTC 时间，精度为 s。
ValueInteger9503380截图总张数。

SnapshotDetailData

参数类型示例值描述
DomainStringexample.com域名。
TotalInteger19503380所选域名的截图总张数。
SnapshotDataListArray of SnapshotDataList-每个聚合时间片的截图张数详情。

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveSnapshotData&Version=2023-01-01

{
    "DomainList": [
        "example.com",
        "example2.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": [
        "example.com",
        "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": "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": "example2.com",
                "Total": 19503380,
                "SnapshotDataList": [
                    {
                        "TimeStamp": "2022-03-07T00:00:00+08:00",
                        "Value": 9503380
                    },
                    {
                        "TimeStamp": "2022-03-08T00:00:00+08:00",
                        "Value": 9507820
                    }
                ]
            }
        ]
    }
}

错误码

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

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