最近更新时间:2023.10.23 16:15:05
首次发布时间:2023.09.25 14:36:18
查询推流峰值流数数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLivePushStreamCountData | 接口名称。当前 API 的名称为 DescribeLivePushStreamCountData 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 否 | ["example1.com","example2.com"] | 域名列表,缺省情况表示该用户的所有域名。 |
StartTime | String | 是 | 2021-08-16T00:00:00+08:00 | 查询的开始时间,RFC3339 格式的 UTC 时间,精度为 s。 |
EndTime | String | 是 | 2021-08-16T00:01:59+08:00 | 查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s。 |
Aggregation | Integer | 否 |
| 聚合的时间粒度,支持以下取值:
|
DetailField | Array of String | 否 | ["Domain"] | 数据拆分的维度,可取元素"Domain",设置为空时不安维度不拆分数据。 |
ISPList | Array of String | 否 |
| 运营商,缺省情况下,表示查询所有运营商,支持的运营商如下所示。
|
UserRegionList | Array of UserRegionList | 否 | - | 客户端 IP 所属区域的列表,缺省情况下表示所有区域。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Area | String | 否 | CN | 大区标识符,如何获取请参见查询区域标识符。 |
Country | String | 否 | CN | 国家标识符,如何获取请参见查询区域标识符。如果按国家筛选,需要同时传入 Area 和 Country 。 |
Province | String | 否 | beijing | 省份标识符,国外暂不支持该参数,如何获取请参见查询区域标识符。如果按省筛选,需要同时传入 Area 、Country 和 Province 。 |
下表仅列出该接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainList | Array of String | ["example.com"] | 域名列表。 |
StartTime | String | 2021-08-16T00:00:00+08:00 | 开始时间。 |
EndTime | String | 2021-08-16T00:01:59+08:00 | 结束时间。 |
Aggregation | Integer | 60 | 聚合的时间粒度。 |
DetailField | Array of String | ["Domain"] | 数据拆分的维度。 |
PeakCount | Integer | 100 | 峰值流数量。 |
TotalStreamDataList | Array of TotalStreamDataList | - | 按指定时间粒度聚合后的峰值流数数据。 |
StreamDetailDataList | Array of StreamDetailDataList | - | 拆分维度字段和时间聚合后数据。 |
ISPList | Array of String | ["telecom"] | 运营商。 |
UserRegionList | Array of UserRegionListResponse | - | 客户端 IP 所属区域列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2021-08-16T00:00:00+08:00 | 时间片的开始时间,RFC3339 格式的 UTC 时间,精度为 s。 |
PeakCount | Integer | 100 | 峰值流数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | example.com | 域名。 |
TotalStreamDataList | Array of TotalStreamDataList | - | 当前数据拆分维度下所有时间粒度的数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Area | String | CN | 大区标识符。 |
Country | String | CN | 国家标识符。 |
Province | String | beijing | 省份标识符。 |
POST https://live.volcengineapi.com?Action=DescribeLivePushStreamCountData&Version=2023-01-01 { "DomainList": [ "example1.com", "example2.com" ], "StartTime": "2021-08-16T00:00:00+08:00", "EndTime": "2021-08-16T00:01:59+08:00", "Aggregation": 60, "DetailField": [ "Domain" ] }
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"DescribeLivePushStreamCountData", "Version":"2023-01-01", "Service":"live", "Region":"cn-north-1" }, "Result": { "DomainList":["example.com","example2.com"], "StartTime": "2021-08-16T00:00:00+08:00", "EndTime": "2021-08-16T00:01:59+08:00", "Aggregation": 60, "DetailField": ["Domain"], "PeakCount": 100, "TotalStreamDataList": [ { "TimeStamp": "2021-08-16T00:00:00+08:00", "PeakCount": 100, } ], "StreamDetailDataList": [ { "Domain": "example.com", "TotalStreamDataList": [ { "TimeStamp": "2021-08-16T00:00:00+08:00", "PeakCount": 100, } ], }, { "Domain": "example2.com", "TotalStreamDataList": [ { "TimeStamp": "2021-08-16T00:00:00+08:00", "PeakCount": 100, } ], } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
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. | 内部服务超时,请联系技术支持。 |