DescribeLiveCallbackData - 查询回调记录--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveCallbackData - 查询回调记录

最近更新时间：2025.04.18 17:53:38首次发布时间：2025.04.18 17:53:38

该接口用于查询直播推流相关的回调记录，包括回调事件类型、状态、请求与响应信息等。可用于定位直播中回调请求异常、验证回调是否成功发送等场景。

注意事项

调用频率：单用户请求频率限制为 30 次/秒。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["example.com", "example2.com"]`	需查询的域名列表，缺省情况下表示当前账号下的所有域名。
App	String	否	`example_app`	应用名称，需与推流地址中保持一致。
Stream	String	否	`example_stream`	流名称，用于精确定位某一路直播流。
CallbackEventType	Array of String	否	`["push_start"]`	回调事件类型。支持以下取值： `push_start`：推流开始 `push_end`：推流结束 `snapshot_event`：截图回调 `record_event`：录制回调
CallbackStatus	Array of String	否	`["success"]`	回调状态。支持以下取值： `success`：成功。 `fail`：失败。
StartTime	String	是	`2021-08-16T00:01:59+08:00`	查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。说明单次查询最大时间跨度为 31 天，历史查询最大时间范围为 366 天。
EndTime	String	是	`2021-08-16T00:01:59+08:00`	查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
PageNum	Integer	否	`1`	查询数据的页码，默认为 1，表示查询第一页的数据。
PageSize	Integer	否	`100`	每页显示的数据条数，默认为 100，表示每页最多展示 100 条数据，取值范围为 [1,1000]。

返回参数

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

参数	类型	示例值	描述
DomainList	Array of String	`["example.com", "example2.com"]`	域名列表。
App	String	`example_app`	应用名称。
Stream	String	`example_stream`	流名称。
CallbackEventType	Array of String	`["push_start"]`	回调事件类型
CallbackStatus	Array of String	`["success"]`	回调状态
StartTime	String	`2021-08-16T00:01:59+08:00`	查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
EndTime	String	`2022-11-11T00:00:00+08:00`	查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
CallbackInfoList	Array of CallbackInfoList	`-`	回调事件详情
Pagination	Object of Pagination	`-`	查询结果的分页信息。

CallbackInfoList

参数	类型	示例值	描述
Domain	String	`example.com`	域名。
App	String	`example_app`	应用名称。
Stream	String	`example_stream`	流名称。
CallbackTime	String	`2022-11-11T00:00:00+08:00`	回调发生时间。
CallbackEventType	String	`push_start`	回调事件类型。
CallbackMethod	String	`post`	回调请求方式。
CallbackAddress	String	`http://example.com/xxx`	回调地址。
CallbackStatus	String	`success`	回调状态
CallbackBody	String	`{}`	回调请求体。
CallbackResponseCode	String	`200`	回调响应码。
CallbackResponseHeader	String	`Content-Type: application/json; charset=utf-8\r\nContent-Length: 29`	回调响应头信息。
CallbackResponseBody	String	`{"error_code":200,"msg":"ok"}`	回调响应体。
CallbackResponseTime	String	`2022-11-11T00:00:00+08:00`	回调响应时间。
CallbackErrorMessage	String	`InternalServiceError`	错误信息，当回调失败时返回。
CallbackErrorCode	String	`回调接收服务不可达，请检查回调地址是否可用.`	回调错误说明。

Pagination

参数	类型	示例值	描述
PageNum	Integer	`1`	当前所在分页的页码。
PageSize	Integer	`100`	每页显示的数据条数。
TotalCount	Integer	`100`	查询结果的数据总条数。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveCallbackData&Version=2023-01-01
{
    "CallbackEventType": [
        "push_end"
    ],
    "CallbackStatus": [
        "success"
    ],
    "StartTime": "2025-03-18T00:00:00+08:00",
    "EndTime": "2025-03-19T00:00:00+08:00"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250410201942D5628AA78C98A0C818D0",
        "Action": "DescribeLiveCallbackData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "CallbackEventType": [
            "push_end"
        ],
        "StartTime": "2025-03-18T00:00:00+08:00",
        "EndTime": "2025-03-19T00:00:00+08:00",
        "CallbackInfoList": [
            {
                "Domain": "example.com",
                "App": "app_test",
                "Stream": "stream-111",
                "CallbackTime": "2025-03-18T23:30:52+08:00",
                "CallbackEventType": "push_end",
                "CallbackMethod": "post",
                "CallbackAddress": "http://example.com/callback/record",
                "CallbackStatus": "success",
                "CallbackBody": "{}",
                "CallbackResponseCode": "200",
                "CallbackResponseHeader": "HTTP/1.1 200 OK",
                "CallbackResponseBody": "{\"error_code\":200,\"msg\":\"ok\"}",
                "CallbackResponseTime": "2025-03-18T23:30:53+08:00",
                "CallbackErrorCode": "",
                "CallbackErrorMessage": ""
            }
        ],
        "Pagination": {
            "PageNum": 1,
            "PageSize": 100,
            "TotalCount": 1
        }
    }
}

错误码

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

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