GetStreamRecord - 查询录像--慢直播-火山引擎

文档中心

立即注册

导航

GetStreamRecord - 查询录像

最近更新时间：2025.06.30 13:08:35首次发布时间：2023.02.03 18:54:55

根据录像任务 ID，查询指定录像任务的结果。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=GetStreamRecord&Version=2021-01-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetStreamRecord	要执行的操作，取值：GetStreamRecord。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
RecordID	String	是	record0xxxx	需要查询的录像任务 ID，record0xxxx

返回参数

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

参数	类型	示例值	描述
ID	String	record0xxx	录制任务唯一 ID，凭借该 ID 可以停止录像、查询录像结果、删除录像
Status	String	success	录像任务状态： success（录像任务成功） error（录像任务出错）
Msg	String	err_msg	错误信息
CreatedAt	Integer	160000000	录像任务创建时间
UpdatedAt	Integer	160000001	录像任务更新时间
StoppedAt	Integer	160000002	录像任务停止时间
Res	Object		录像任务结果，参考以下 StreamRecordResult 结构说明

请求示例

POST /?Action=GetStreamRecord&Version=2021-01-01&RecordID=record0xxxx HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241219T032853Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241219/cn-beijing/aiotvideo/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241219112856235000132208A3DAF2",
    "Action": "GetStreamRecord",
    "Version": "2021-01-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  },
  "Result": {
    "ID": "record0xxx",
    "Status": "success",
    "Msg": "err_msg",
    "CreatedAt": 160000000,
    "UpdatedAt": 160000001,
    "StoppedAt": 160000002,
    "Res": {
      "Url": "https://xxxx",
      "RemuxUrl": "https://xxxx",
      "Extra": {}
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
200	ErrorStreamRecordDB	InternalError.StreamPushRecord
400	InvalidParameter.GetStreamRecord	The request is failed due to recordid is empty.
500	InternalError.GetStreamRecord	The request is failed due to request data not found.