调用该接口查询摄像头设备的图片信息。

使用限制

如果在企业版实例中调用该接口,必须传入参数IotInstanceId的值。否则,调用接口会失败。

调试

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

请求参数

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

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

CaptureId String fdc576d03c094faea9fa10fbf48c****

抓图事件发生时,生成的图片ID。

IotId String zLZyi6aOLyOSHa9hsPyD00****

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

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

PictureType Integer 1

图片类型。

  • 0:缩略图
  • 1:原图
  • 2(默认):全部
IotInstanceId String iot-cn-n6w1y******

实例ID。

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

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

返回数据

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

调用失败时,返回的错误码。

Data Struct

响应结果。

IotId String zLZyi6aOLyOSHa9hsPyD00****

设备ID。

PicCreateTime Long 1543474290903

图片创建时间,格式为13位时间戳,单位为毫秒。

PicId String Picid_15268432

图片ID。

PicUrl String http://***_normal.jpg

原图URL。

说明 URL有效期为1小时。
ThumbUrl String http://***.jpg

缩略图URL。

说明 URL有效期为1小时。
ErrorMessage String request forbidden

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

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

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryDevicePictureFile
&CaptureId=fdc576d03c094faea9fa10fbf48c****
&IotId=zLZyi6aOLyOSHa9hsPyD00****
&IotInstanceId=iot-cn-n6w1y******
&<公共请求参数>

正常返回示例

XML格式

<QueryDevicePictureFileResponse>
  <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
  <Data>
        <IotId>zLZyi6aOLyOSHa9hsPyD00****</IotId>
        <ThumbUrl>http://***.jpg</ThumbUrl>
        <PicUrl>http://***_normal.jpg</PicUrl>
        <PicId>Picid_15268432</PicId>
        <PicCreateTime>1543474290903</PicCreateTime>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryDevicePictureFileResponse>

JSON格式

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Data": {
        "IotId": "zLZyi6aOLyOSHa9hsPyD00****",
        "ThumbUrl": "http://***.jpg",
        "PicUrl": "http://***_normal.jpg",
        "PicId": "Picid_15268432",
        "PicCreateTime": "1543474290903"
    },
    "Code": "200",
    "Success": "true"
}

错误码

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