调用该接口通过录像文件ID查询录像文件URL。

使用限制

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

调试

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

请求参数

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

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

IotId String zLZyi6aOLyOSHa9hsPyD00****

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

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

RecordId String 2c5bf5b6a8704bd3a6a1517fd125****

录像文件ID。可调用QueryRecord查询。

IotInstanceId String iot-060a01****

实例ID。

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

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

返回数据

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

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

Data Array of Data

返回信息。

BeginTime String 2020-10-12 14:07:20

录像开始时间。

EndTime String 2020-10-12 14:07:31

录像结束时间。

FileName String test

录像文件名。

VodUrl String https://xxxxxxxxxxxxx

录像文件的URL。

ErrorMessage String RecordId is mandatory for this action.

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

RequestId String F46E12A5-633D-4761-80F2-285752A052D5

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryRecordByRecordId
&IotId=zLZyi6aOLyOSHa9hsPyD00****
&RecordId=2c5bf5b6a8704bd3a6a1517fd125****
&IotInstanceId=iot-060a01****
&<公共请求参数>

正常返回示例

XML格式

<QueryRecordByRecordIdResponse>
  <RequestId>F46E12A5-633D-4761-80F2-285752A052D5</RequestId>
  <Data>
        <EndTime>2020-10-12 14:07:31</EndTime>
        <FileName>test</FileName>
        <BeginTime>2020-10-12 14:07:20</BeginTime>
        <VodUrl>https://xxxxxxxxxxxxx</VodUrl>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryRecordByRecordIdResponse>

JSON格式

{
    "RequestId": "F46E12A5-633D-4761-80F2-285752A052D5",
    "Data": [
        {
            "EndTime": "2020-10-12 14:07:31",
            "FileName": "test",
            "BeginTime": "2020-10-12 14:07:20",
            "VodUrl": "https://xxxxxxxxxxxxx"
        }
    ],
    "Code": "200",
    "Success": "true"
}

错误码

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