DescribeLivePlayStatusCodeData - 查询域名状态码占比--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLivePlayStatusCodeData - 查询域名状态码占比

最近更新时间：2025.04.22 19:10:55首次发布时间：2023.09.25 14:36:18

调用 DescribeLivePlayStatusCodeData 接口，查询指定时间范围内域名请求的状态码占比数据，包含推流请求、拉流请求和回源请求。

注意事项

使用限制：支持查询指定域名（包含已删除域名）产生的推拉流请求或回源请求状态码占比数据。
请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：数据延迟为 15 分钟。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["push.example.com", "pull.example.com"]`	域名列表，默认为空时表示查询所有域名下产生的请求状态码占比数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询请求状态码占比数据的域名。
ISPList	Array of String	否	`["telecom"]`	提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数。您也可以通过 DescribeLiveISPData 接口获取运营商对应的标识符。
RegionList	Array of Region	否	`-`	CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。说明参数 `RegionList`和`UserRegionList` 不支持同时传入。
UserRegionList	Array of Region	否	`-`	客户端 IP 所属区域的列表，缺省情况下表示所有区域。说明参数 `RegionList`和`UserRegionList` 不支持同时传入。
StartTime	String	是	`2024-04-28T14:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	是	`2024-04-28T14:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	否	`300`	聚合的时间粒度，单位为秒，支持的时间粒度如下所示。 `60`：（默认值）1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； `300`：5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
DetailField	Array of String	否	`["Domain"]`	数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。 `Domain`：域名； `ISP`：运营商。说明配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
Type	String	否	`Access`	请求类型，取值及含义如下所示。 `Access`：（默认值）推流请求和拉流请求； `Source`：回源请求。

Region

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

返回参数

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

参数	类型	示例值	描述
DomainList	Array of String	`["push.example.com", "pull.example.com"]`	域名列表。
ISPList	Array of String	`["telecom"]`	提供网络接入服务的运营商标识符，标识符与运营商的对应关系如下。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数。
RegionList	Array of Region	`-`	CDN 节点 IP 所属区域列表。
UserRegionList	Array of Region	`-`	客户端 IP 所属区域列表。
StartTime	String	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`300`	聚合的时间粒度，单位为秒。 `60`：1 分钟； `300`：5 分钟； `3600`：1 小时。
DetailField	Array of String	`["Domain"]`	数据拆分的维度，维度说明如下所示。 `Domain`：域名； `ISP`：运营商。
StatusSummaryDataList	Array of StatusSummaryData	`-`	当前查询条件下的状态码占比数据。
StatusDataList	Array of StatusData	`-`	所有时间粒度的数据。
StatusDetailDataList	Array of StatusDetailData	`-`	按维度拆分后的数据。
Type	String	`Access`	请求类型，取值及含义如下所示。 `Access`：推流请求和拉流请求； `Source`：回源请求。

Region

参数	类型	示例值	描述
Area	String	`CN`	区域信息中的大区标识符。
Country	String	`CN`	区域信息中的国家标识符。
Province	String	`beijing`	区域信息中的省份标识符。

StatusSummaryData

参数	类型	示例值	描述
StatusCode	Integer	`400`	请求的状态码。
Value	Integer	`67`	当前状态码出现的次数。
Percent	Float	`67`	当前状态码出现次数在总状态码次数中的占比。

StatusData

参数	类型	示例值	描述
TimeStamp	String	`2021-08-16T00:00:00+08:00`	数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
StatusSummaryDataList	Array of StatusSummaryData	`-`	当前数据聚合时间粒度内的状态码详细数据。

StatusDetailData

参数	类型	示例值	描述
Domain	String	`pull.example.com`	拉流域名。
ISP	String	`unicom`	运营商。
StatusDataList	Array of StatusData	`-`	每个时间点的粒度数据。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLivePlayStatusCodeData&Version=2023-01-01
{
    "StartTime": "2024-04-28T14:00:00+08:00",
    "EndTime": "2024-04-28T18:00:00+08:00",
    "DomainList": [
        "push.example.com",
        "pull.example.com"
    ],
    "Aggregation": 3600,
    "DetailField": [
        "Domain"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240429115020EFB8B57C6DD6E55006CC",
        "Action": "DescribeLivePlayStatusCodeData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-beijing"
    },
    "Result": {
        "DomainList": [
            "push.example.com",
            "pull.example.com"
        ],
        "DetailField": [
            "Domain"
        ],
        "StartTime": "2024-04-28T14:00:00+08:00",
        "EndTime": "2024-04-28T18:00:00+08:00",
        "Aggregation": 3600,
        "StatusSummaryDataList": [
            {
                "StatusCode": 200,
                "Value": 2,
                "Percent": 100
            }
        ],
        "StatusDataList": [
            {
                "TimeStamp": "2024-04-28T14:00:00+08:00",
                "StatusSummaryDataList": [
                    {
                        "StatusCode": 200,
                        "Value": 1,
                        "Percent": 100
                    }
                ]
            },
            {
                "TimeStamp": "2024-04-28T15:00:00+08:00",
                "StatusSummaryDataList": [
                    {
                        "StatusCode": 200,
                        "Value": 0,
                        "Percent": 0
                    }
                ]
            },
            {
                "TimeStamp": "2024-04-28T16:00:00+08:00",
                "StatusSummaryDataList": [
                    {
                        "StatusCode": 200,
                        "Value": 0,
                        "Percent": 0
                    }
                ]
            },
            {
                "TimeStamp": "2024-04-28T17:00:00+08:00",
                "StatusSummaryDataList": [
                    {
                        "StatusCode": 200,
                        "Value": 1,
                        "Percent": 100
                    }
                ]
            }
        ],
        "StatusDetailDataList": [
            {
                "Domain": "push.example.com",
                "StatusDataList": [
                    {
                        "TimeStamp": "2024-04-28T14:00:00+08:00",
                        "StatusSummaryDataList": [
                            {
                                "StatusCode": 200,
                                "Value": 1,
                                "Percent": 100
                            }
                        ]
                    },
                    {
                        "TimeStamp": "2024-04-28T15:00:00+08:00",
                        "StatusSummaryDataList": [
                            {
                                "StatusCode": 200,
                                "Value": 0,
                                "Percent": 0
                            }
                        ]
                    },
                    {
                        "TimeStamp": "2024-04-28T16:00:00+08:00",
                        "StatusSummaryDataList": [
                            {
                                "StatusCode": 200,
                                "Value": 0,
                                "Percent": 0
                            }
                        ]
                    },
                    {
                        "TimeStamp": "2024-04-28T17:00:00+08:00",
                        "StatusSummaryDataList": [
                            {
                                "StatusCode": 200,
                                "Value": 1,
                                "Percent": 100
                            }
                        ]
                    }
                ]
            },
            {
                "Domain": "pull.example.com",
                "StatusDataList": [
                    {
                        "TimeStamp": "2024-04-28T14:00:00+08:00",
                        "StatusSummaryDataList": []
                    },
                    {
                        "TimeStamp": "2024-04-28T15:00:00+08:00",
                        "StatusSummaryDataList": []
                    },
                    {
                        "TimeStamp": "2024-04-28T16:00:00+08:00",
                        "StatusSummaryDataList": []
                    },
                    {
                        "TimeStamp": "2024-04-28T17:00:00+08:00",
                        "StatusSummaryDataList": []
                    }
                ]
            }
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。