最近更新时间:2023.11.13 13:47:54
首次发布时间:2023.09.25 14:36:18
查询一定时间范围内直播拉流请求的状态码占比数据,支持按地区和运营商区分。支持查询删除域名的状态码数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLivePlayStatusCodeData | 接口名称。当前 API 的名称为 DescribeLivePlayStatusCodeData 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-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。 |
EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s。 |
Aggregation | Integer | 否 |
| 聚合的时间粒度,单位秒,默认值为 60。支持以下粒度。
|
DetailField | Array of String | 否 | ["Domain"] | 数据拆分的维度,可取值为 "Domain","ISP",设置为空时不进行数据拆分。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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 | 时间粒度。 |
DetailField | Array of String | ["Domain"] | 是否返回过滤字段和时间聚合后的数据。 |
StatusSummaryDataList | Array of StatusSummaryData | - | 所有时间数据总量。 |
StatusDataList | Array of StatusData | - | 每个时间点的粒度数据。 |
StatusDetailDataList | Array of StatusDetailData | - | 字段和时间聚合后数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Area | String | CN | 大区标识符。 |
Country | String | CN | 国家标识符。 |
Province | String | beijing | 省份标识符。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
StatusCode | Integer | 400 | 状态码。 |
Value | Integer | 67 | 出现次数。 |
Percent | Float | 67 | 占比。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2021-08-16T00:00:00+08:00 | 时间片起始时刻。RFC3339 格式的 UTC 时间,精度为 s。 |
StatusSummaryDataList | Array of StatusSummaryDataList | - | 按状态码区分的数据列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | example2.com | 域名。 |
ISP | String | unicom | 运营商。 |
StatusDataList | Array of StatusDataList | - | 每个时间点的粒度数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
StatusCode | Integer | 400 | 状态码。 |
Value | Integer | 67 | 出现次数。 |
Percent | Float | 67 | 占比。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2021-08-16T00:00:00+08:00 | 时间片起始时刻。RFC3339 格式的 UTC 时间,精度为 s。 |
StatusSummaryDataList | Array 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" ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | CommonErr | - | 未分类错误。建议重试,如果仍返回该错误码,请联系技术支持。 |
400 | InvalidParam | - | 输入的参数无效或不符合要求,请参照请求参数说明进行检查。 |
400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验,请检查参数类型是否正确。 |
403 | RequestForbidden | - | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
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. | 内部服务超时,请联系技术支持。 |