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

查询域名状态码占比

最近更新时间：2023.11.13 13:47:54

首次发布时间：2023.09.25 14:36:18

我的收藏

查询一定时间范围内直播拉流请求的状态码占比数据，支持按地区和运营商区分。支持查询删除域名的状态码数据。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainListArray of String否["example.com", "example2.com"]拉流域名列表，默认为账号下全部域名。

ISPList

Array of String

否

["telecom"]

运营商，缺省情况下，表示查询所有运营商，支持的运营商如下所示。

  • unicom：联通；
  • railcom：铁通；
  • telecom：电信；
  • mobile：移动；
  • cernet：教育网；
  • tianwei：天威；
  • alibaba：阿里巴巴；
  • tencent：腾讯；
  • drpeng：鹏博士；
  • btvn：广电；
  • huashu：华数；
  • other：其他。

RegionList

Array of Region

否

-

CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。区域代号和区域的映射关系如下所示。

  • all：全部，独立查询；
  • CN：中国内地；
  • OverSeas：海外所有大区，包含下属所有大区，独立查询；
  • AP1：亚太一区；
  • AP2：亚太二区；
  • AP3：亚太三区；
  • EU：欧洲；
  • MEAA：中东；
  • SA：南美；
  • NA：北美；
  • Other：无法定位的数据，独立查询。

说明

RegionList和UserRegionList传且仅传一个

UserRegionList

Array of Region

否

-

客户端 IP 所属区域的列表，缺省情况下表示所有区域。区域代号和区域的映射关系如下所示。

  • all：全部，独立查询；
  • CN：中国内地；
  • OverSeas：海外所有大区，包含下属所有大区，独立查询；
  • AP1：亚太一区；
  • AP2：亚太二区；
  • AP3：亚太三区；
  • EU：欧洲；
  • MEAA：中东；
  • SA：南美；
  • NA：北美；
  • Other：无法定位的数据，独立查询。

说明

RegionList和UserRegionList传且仅传一个

StartTimeString是2021-04-13T00:00:00+08:00查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s。
EndTimeString是2021-04-14T00:00:00+08:00查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s。

Aggregation

Integer

否

300

聚合的时间粒度，单位秒，默认值为 60。支持以下粒度。

  • 60：支持单次查询时间跨度为 24 小时，历史查询时间范围为 7 天；
  • 300：支持单次查询时间跨度为 31 天，历史查询时间范围为 93 天；
  • 3600：支持单次查询时间跨度为 93 天，历史查询时间范围为 93 天。
DetailFieldArray of String否["Domain"]数据拆分的维度，可取值为 "Domain"，"ISP"，设置为空时不进行数据拆分。

Region

参数类型是否必选示例值描述
AreaString否CN大区标识符，如何获取请参见查询区域标识符。
CountryString否CN国家标识符，如何获取请参见查询区域标识符。如果按国家筛选，需要同时传入 Area 和 Country。
ProvinceString否beijing省份标识符，国外暂不支持该参数，如何获取请参见查询区域标识符。如果按省筛选，需要同时传入 Area、Country 和 Province。

返回参数

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

参数类型示例值描述
DomainListArray of String["example.com", "example2.com"]拉流域名列表。
ISPListArray of String["telecom"]运营商。
RegionListArray of RegionResponse-CDN 节点 IP 所属区域。
UserRegionListArray of RegionResponse-客户端 IP 所属区域。
StartTimeString2021-04-13T00:00:00+08:00起始时间。
EndTimeString2021-04-14T00:00:00+08:00结束时间。
AggregationInteger300时间粒度。
DetailFieldArray of String["Domain"]是否返回过滤字段和时间聚合后的数据。
StatusSummaryDataListArray of StatusSummaryData-所有时间数据总量。
StatusDataListArray of StatusData-每个时间点的粒度数据。
StatusDetailDataListArray of StatusDetailData-字段和时间聚合后数据。

RegionResponse

参数类型示例值描述
AreaStringCN大区标识符。
CountryStringCN国家标识符。
ProvinceStringbeijing省份标识符。

StatusSummaryData

参数类型示例值描述
StatusCodeInteger400状态码。
ValueInteger67出现次数。
PercentFloat67占比。

StatusData

参数类型示例值描述
TimeStampString2021-08-16T00:00:00+08:00时间片起始时刻。RFC3339 格式的 UTC 时间，精度为 s。
StatusSummaryDataListArray of StatusSummaryDataList-按状态码区分的数据列表。

StatusDetailData

参数类型示例值描述
DomainStringexample2.com域名。
ISPStringunicom运营商。
StatusDataListArray of StatusDataList-每个时间点的粒度数据。

StatusSummaryDataList

参数类型示例值描述
StatusCodeInteger400状态码。
ValueInteger67出现次数。
PercentFloat67占比。

StatusDataList

参数类型示例值描述
TimeStampString2021-08-16T00:00:00+08:00时间片起始时刻。RFC3339 格式的 UTC 时间，精度为 s。
StatusSummaryDataListArray of StatusSummaryDataList-按状态码区分的数据列表。

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLivePlayStatusCodeData&Version=2023-01-01
{
  "DomainList": [
    "example2.com"
  ],
  "StartTime": "2021-08-16T00:00:00+08:00",
  "EndTime": "2021-08-16T00:01:59+08:00",
  "Aggregation": 60,
  "DetailField": [
    "Domain"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "DescribeLivePlayStatusCodeData",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "StartTime": "2021-04-13T00:00:00+08:00",
    "EndTime": "2021-04-14T00:00:00+08:00",
    "Aggregation": 300,
    "StatusSummaryDataList": "-",
    "StatusDataList": "-",
    "RegionList": "-",
    "UserRegionList": "-",
    "DomainList": [
      "example.com",
      "example2.com"
    ],
    "ISPList": [
      "telecom"
    ],
    "StatusDetailDataList": "-",
    "DetailField": [
      "Domain"
    ]
  }
}

错误码

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

状态码错误码错误信息说明
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.内部服务超时，请联系技术支持。