最近更新时间：2023.09.25 21:10:01
首次发布时间：2023.02.28 21:28:25
查询一定时间范围内直播拉流请求的状态码占比数据，支持按地区和运营商区分。支持查询删除域名的状态码数据。
说明
该接口数据历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询域名状态码占比接口。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeLivePlayStatusCodeData | 接口名称。当前 API 的名称为 DescribeLivePlayStatusCodeData。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| DomainList | Array of String | 否 | ["example.com", "example2.com"] | 拉流域名列表，默认为账号下全部域名 |
ISPList | Array of String | 否 |
| 运营商，缺省情况下，表示查询所有运营商，支持的运营商如下所示。
|
RegionList | Array of Region | 否 |
| CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。区域代号和区域的映射关系如下所示。
说明
|
UserRegionList | Array of Region | 否 |
| 客户端 IP 所属区域的列表，缺省情况下表示所有区域。区域代号和区域的映射关系如下所示。
说明
|
| StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s，例如，2022-04-13T00:00:00+08:00 |
| EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s，例如，2022-04-13T00:00:00+08:00 |
Aggregation | Integer | 否 |
| 聚合的时间粒度，单位秒，默认值为 60。支持以下粒度。
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Area | String | 否 | CN | 大区，映射关系请参见区域映射 |
| Country | String | 否 | CN | 国家，映射关系请参见区域映射。如果按国家筛选，需要同时传入 Area 和 Country。 |
| Province | String | 否 | beijing | 国内为省，国外暂不支持该参数，映射关系请参见区域映射。如果按省筛选，需要同时传入 Area、Country 和 Province。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| DomainList | Array of String | ["example.com", "example2.com"] | 拉流域名列表 |
| ISPList | Array of String | ["telecom"] | 运营商 |
| RegionList | Array of RegionResponse | - | CDN 节点 IP 所属区域 |
| UserRegionList | Array of RegionResponse | - | 客户端 IP 所属区域 |
| StartTime | String | 2021-04-13T00:00:00+08:00 | 起始时间 |
| EndTime | String | 2021-04-14T00:00:00+08:00 | 结束时间 |
| Aggregation | Integer | 300 | 时间粒度 |
| SummaryStatusList | Array of SummaryStatusData | - | 按状态码区分的数据列表 |
| TotalStatusDataList | Array of TotalStatusData | - | 按指定时间粒度聚合的状态码数据 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Area | String | CN | 大区，映射关系请参见区域映射 |
| Country | String | CN | 国家，映射关系请参见区域映射 |
| Province | String | beijing | 国内为省，国外暂不支持该参数，映射关系请参见区域映射 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| StatusCode | Integer | 400 | 状态码，不按分组进行汇总 |
| Count | Integer | 67 | 状态码数量 |
| Percent | Float | 67 | 所占请求数量的占比 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Timestamp | String | 2021-04-14T00:00:00+08:00 | 时间片起始时刻。RFC3339 格式的 UTC 时间，精度为 s，例如，2022-04-13T00:00:00+08:00 |
| SummaryStatusData | Array 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 } ] } ] } }
访问公共错误码获取详细信息。