调用该接口立即触发指定摄像头开始录像,并上传录像文件至云端。

使用限制

如果在企业版实例中调用该接口,请求参数IotInstanceId必须填写。否则,调用接口会失败。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String TriggerRecord

系统规定参数。取值:TriggerRecord。

IotId String zLZyi6aOLyOSHa****yD000100

要查询的摄像头的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。

可调用物联网平台QueryDeviceDetail查询。

RecordDuration Integer 60

录像时长,包括预录时长,取值范围10~7200,单位为秒。

说明 单个录像文件长度最大为30分钟,当录像时长大于30分钟时,会自动切割成多个录像文件。
StreamType Integer 0

码流类型:

  • 0(默认):主码流
  • 1:辅码流
PreRecordDuration Integer 5

预录时长,取值范围0~10,单位为秒。

说明 设备具备预录功能时,才可生成预录时长,否则,预录时长为0。
IotInstanceId String iot-cn-n6w1y5xxxx0t

实例ID。

  • 企业版实例:必须传入此参数。您可在物联网平台控制台的实例概览页面,查看您的企业版实例ID。
  • 公共实例:无需传入此参数。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String 200

调用失败时,返回的错误码。更多信息,请参见错误码

Data String fc82774fa749485bad7d719f9670****

摄像头录像上传后,生成的录像文件ID。

ErrorMessage String tenant auth error

调用失败时,返回的出错信息。

RequestId String 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功:

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=TriggerRecord
&IotId=zLZyi6aOLyOSHa****yD000100
&RecordDuration=60
&<公共请求参数>

正常返回示例

XML格式

<TriggerRecordResponse>
      <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
      <Data>fc82774fa749485bad7d719f9670****</Data>
      <Code>200</Code>
      <Success>true</Success>
</TriggerRecordResponse>

JSON格式

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Data": "fc82774fa749485bad7d719f9670****",
    "Code": "200",
    "Success": "true"
}

错误码

访问错误中心查看更多错误码。