You need to enable JavaScript to run this app.
导航
查询域名状态码占比
最近更新时间:2023.10.12 17:39:59首次发布时间:2023.02.28 21:28:25

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

说明

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

注意事项

  • 请求频率:单用户请求频率限制为 100 次/秒
  • 数据延迟:数据延迟为 3min

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeLivePlayStatusCodeData接口名称。当前 API 的名称为 DescribeLivePlayStatusCodeData
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-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:无法定位的数据,独立查询。

说明

RegionListUserRegionList传且仅传一个

UserRegionList

Array of Region

-

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

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

说明

RegionListUserRegionList传且仅传一个

StartTimeString2021-04-13T00:00:00+08:00查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-13T00:00:00+08:00
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-13T00:00:00+08:00

Aggregation

Integer

300

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

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

Region

参数类型是否必选示例值描述
AreaStringCN大区,映射关系请参见区域映射
CountryStringCN国家,映射关系请参见区域映射。如果按国家筛选,需要同时传入 Area 和 Country
ProvinceStringbeijing国内为省,国外暂不支持该参数,映射关系请参见区域映射。如果按省筛选,需要同时传入 AreaCountry 和 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时间粒度
SummaryStatusListArray of SummaryStatusData-按状态码区分的数据列表
TotalStatusDataListArray of TotalStatusData-按指定时间粒度聚合的状态码数据

RegionResponse

参数类型示例值描述
AreaStringCN大区,映射关系请参见区域映射
CountryStringCN国家,映射关系请参见区域映射
ProvinceStringbeijing国内为省,国外暂不支持该参数,映射关系请参见区域映射

SummaryStatusData

参数类型示例值描述
StatusCodeInteger400状态码,不按分组进行汇总
CountInteger67状态码数量
PercentFloat67所占请求数量的占比

TotalStatusData

参数类型示例值描述
TimestampString2021-04-14T00:00:00+08:00时间片起始时刻。RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-13T00:00:00+08:00
SummaryStatusDataArray of SummaryStatusData-按状态码区分的数据列表

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLivePlayStatusCodeData&Version=2020-08-01
{
  "UserRegionList": [
    {
      "Area": "CN",
      "Country": "CN",
      "Province": "guangdong"
    }
  ],
  "StartTime": "2021-08-16T00:00:00+08:00",
  "EndTime": "2021-08-16T00:01:59+08:00",
  "Aggregation": 60
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"DescribeLivePlayStatusCodeData",
        "Version":"2020-08-01",
        "Service":"live",
        "Region":"cn-north-1"
    },
    "Result": {
    "UserRegionList":[
		    {
				    "Area":"CN",
					  "Country":"CN",
					  "Province":"guangdong"
				}
		],
        "StartTime": "2021-08-16T00:00:00+08:00",
        "EndTime": "2021-08-16T00:01:59+08:00",
        "Aggregation": 60
        "SummaryStatusList": [
            {
                "StatusCode": 400,
                "Count": 67,
                "Percent": 67
            }  
        ]
        "TotalStatusDataList": [
            {
               "Timestamp": "2021-08-16T00:00:00+08:00",
               "SummaryStatusData": [
                  {
                     "StatusCode": 400,
                     "Count": 67,
                     "Percent": 67
                  }
              ]
            }
        ]
   }
}

错误码

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