You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询截图历史详情

最近更新时间：2023.11.01 10:46:35

首次发布时间：2023.09.25 14:34:04

我的收藏

调用接口查询指定 Vhost 下的直播截图历史详情。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DescribeCDNSnapshotHistory接口名称。当前 API 的名称为 DescribeCDNSnapshotHistory。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间名称。由 1 到 60 位数字、字母、下划线及"-"和"."组成。
AppString是live应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
StreamString是stream-123流名称，由 1 到 100 位数字、字母、下划线及"-"和"."组成，如果指定 Stream，必须同时指定 App 的值。
DateFromString是2022-04-01T00:00:00+08:00查询时间范围的开始时间，RFC3339 格式的 UTC 时间，精度为 s。当您查询指定截图任务详情时，DateFrom 应设置为开始时间之前的任意时间。
DateToString是2022-04-02T00:00:00+08:00查询时间范围的结束时间，结束时间需晚于 DateFrom，且与 DateFrom 间隔不超过 7天，RFC3339 格式的 UTC 时间，精度为 s。
PageNumInteger否1分页查询页码。
PageSizeInteger否30单个分页中，查询的结果数量。

Type

String

否

tos

截图文件保存位置。默认取值为 tos。

  • tos
  • imageX

返回参数

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

参数类型示例值描述
StreamInfoListArray of StreamInfoList-截图历史列表记录。
PaginationObject of Pagination-分页信息。

StreamInfoList

参数类型示例值描述
VhostStringpush.example.com域名空间名称。
AppStringlive应用名称。
StreamStringstream-123流名称。
PathString20210830135051697.jpeg截图文件保存的路径。
FileSizeFloat0文件大小。
TimeStampString2021-08-30 21:48:25.000截图时间戳。
WidthInteger720视频宽度。
HeightInteger1280视频高度。

Pagination

参数类型示例值描述
PageCurInteger1当前页。
PageSizeInteger20当前页的大小。
PageTotalInteger231当前页的数据量。
TotalCountInteger4613数据总量。

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeCDNSnapshotHistory&Version=2023-01-01
{
  "Vhost": "push.example.com",
  "App": "live",
  "Stream": "stream-123"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"DescribeCDNSnapshotHistory",
        "Version":"2023-01-01",
        "Service":"live",
        "Region":"cn-north-1"
    },
    "Result":{
        "Data":[
            {
                "App": "live",
                "FileSize": 0,
                "Height": 1280,
                "Path": "20210830135051697.jpeg",
                "Stream": "testStream413",
                "TimeStamp": "2021-08-30 21:48:25.000",
                "Vhost": "example.org",
                "Width": 720
            }
        ],
        "Pagination":{
            "PageCur":1,
            "PageSize":20,
            "PageTotal":231,
            "TotalCount":4613
        }
    }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。