You need to enable JavaScript to run this app.
导航

查询拉流转推带宽用量

最近更新时间2023.12.04 11:00:42

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

查询一定时间范围内,直播拉流转推至第三方的带宽用量。

注意事项

  • 请求频率:单用户请求频率限制为 100 次/秒
  • 数据延迟:数据延迟为 15 分钟
  • 数据进制:带宽数据统计进制为 1000,例如,1 Mbps = 1000 Kbps。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainListArray of String["example.com"]推流域名列表,缺省情况表示当前账号下的所有域名。
StartTimeString2021-04-13T00:00:00+08:00查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s。
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s。

Aggregation

Integer

300

时间粒度,单位为 s,默认值为 300。

  • 300:支持单次查询时间跨度为 31 天,历史查询时间范围为 93 天;
  • 3600:支持单次查询时间跨度为 93 天,历史查询时间范围为 93 天;
  • 86400:支持单次查询时间跨度为 366 天,历史查询时间范围为 366 天。

DstAddrTypeList

Array of String

["live","Third"]

推流地址类型,缺省情况下表示查询 Third,支持 2 种取值。

  • Live:非第三方;
  • Third:第三方。
DetailFieldArray of String["Domain"]数据拆分的维度,可取值为 "Domain","DstAddrType",设置为空时不进行数据拆分。

返回参数

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

参数类型示例值描述
DomainListArray of String["example.com"]域名列表。
StartTimeString2021-04-13T00:00:00+08:00查询的起始时间。
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间。
AggregationInteger300时间粒度。

DstAddrTypeList

Array of String

["live","Third"]

推流地址类型。

  • Live:非第三方;
  • Third:第三方。
DetailFieldArray of String["Domain"]数据拆分的维度。
PeakUpBandwidthFloat12转推带宽峰值,单位为 Mbps。
BandwidthDataListArray of BandwidthDataList-所有时间粒度数据。
BandwidthDetailDataListArray of BandwidthDetailDataList-过滤字段和时间聚合后的数据。

BandwidthDataList

参数类型示例值描述
TimeStampString2022-04-13T00:00:00+08:00时间片起始时刻。RFC3339 格式的 UTC 时间,精度为 s。
UpBandwidthFloat12.0转推带宽,单位为 Mbps。

BandwidthDetailDataList

参数类型示例值描述
DomainStringexample.com域名。

DstAddrType

String

Live

推流地址类型。

  • Live:非第三方;
  • Third:第三方。
PeakUpBandwidthFloat12.0转推带宽峰值,单位为 Mbps。
BandwidthDataListArray of BandwidthDataList-所有时间粒度数据。

示例

请求示例

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

{
    "DomainList": [
        "example.com"
    ],
    "DstAddrTypeList": [
        "live",
        "Third"
    ],
    "StartTime": "2021-04-13T00:00:00+08:00",
    "EndTime": "2021-04-14T00:00:00+08:00",
    "Aggregation": 300,
    "DetailField": [
        "Domain"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeLivePullToPushBandwidthData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "DomainList": [
            "example.com"
        ],
        "DstAddrTypeList": [
            "Live",
            "Third"
        ],
        "StartTime": "2021-04-13T00:00:00+08:00",
        "EndTime": "2021-04-14T00:00:00+08:00",
        "Aggregation": 300,
        "DetailField": [
            "Domain"
        ],
        "PeakUpBandwidth": 12,
        "BandwidthDataList": [
            {
                "TimeStamp": "2022-04-13T00:00:00+08:00",
                "UpBandwidth": 12
            },
            {
                "TimeStamp": "2022-04-13T00:00:05+08:00",
                "UpBandwidth": 10
            }
        ],
        "BandwidthDetailDataList": [
            {
                "DstAddrType": "Live",
                "PeakUpBandwidth": 12,
                "BandwidthDataList": [
                    {
                        "TimeStamp": "2022-04-13T00:00:00+08:00",
                        "UpBandwidth": 12
                    },
                    {
                        "TimeStamp": "2022-04-13T00:00:05+08:00",
                        "UpBandwidth": 10
                    }
                ]
            },
            {
                "DstAddrType": "Third",
                "PeakUpBandwidth": 12,
                "BandwidthDataList": [
                    {
                        "TimeStamp": "2022-04-13T00:00:00+08:00",
                        "UpBandwidth": 12
                    },
                    {
                        "TimeStamp": "2022-04-13T00:00:05+08:00",
                        "UpBandwidth": 10
                    }
                ]
            }
        ]
    }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
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.内部服务超时,请联系技术支持