You need to enable JavaScript to run this app.
导航
查询直播域名录制用量
最近更新时间:2023.10.12 17:39:57首次发布时间:2021.11.22 11:40:05

支持按照域名维度(含删除域名)查询录制用量,日录制用量为一个自然日内的录制并发路数峰值。录制用量查询支持 5 分钟、1 小时、1 天和 1 月的粒度聚合。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询直播域名录制用量接口。

注意事项

请求频率:单用户请求频率限制为 1 次/分钟

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeRecordData接口名称。当前 API 的名称为 DescribeRecordData
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

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

Aggregation

Integer

300

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

  • 300:支持单次查询时间跨度为 31 天,历史查询时间范围为 93 天;
  • 3600:支持单次查询时间跨度为 93 天,历史查询时间范围为 93 天;
  • 86400:支持单次查询时间跨度为 366 天,历史查询时间范围为 366 天;
  • 2592000:代表按自然月聚合,天数为 28 天~31 天不等。支持单次查询时间跨度为 1 年,历史查询时间范围为 2 年。

返回参数

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

参数类型示例值描述
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
AggregationInteger300时间粒度,单位为 s
MaxInteger2查询时间范围内录制峰值
ListArray of RecordData-录制峰值数据

RecordData

参数类型示例值描述
TimeString2021-04-13T00:00:00+08:00时间
ValueInteger1录制峰值

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeRecordData&Version=2020-08-01
{
  "StartTime": "2021-04-13T00:00:00+08:00",
  "EndTime": "2021-04-14T00:10:00+08:00",
  "Aggregation": 300
}

返回示例

{
    "ResponseMetadata":{
        "RequestId": "201806041104200100100***",
        "Action": "DescribeRecordData",
        "Version": "2020-08-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
  	"Result":{
    "Max": 2,
    "List": [
      {
        "Time": "2021-04-13T00:00:00+08:00",
        "Value": 1,
      },
      {
        "Time": "2021-04-14T00:05:00+08:00",
        "Value": 2,
      },
    ]
  }
}

错误码

访问公共错误码获取详细信息。