调用该接口查询IPC设备获取的图片信息。

调试

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

请求参数

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

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

CaptureId String fdc576d03c094faea9fa10fbf48c****

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

ProductKey String a1BwAGV****

IPC设备所属产品的ProductKey。

您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。

注意 如果传入该参数,需同时传入DeviceName
DeviceName String camera1

IPC设备的设备名称。

您可以在物联网平台控制台的设备页查看DeviceName

注意 如果传入该参数,需同时传入ProductKey
IotId String zLZyi6aOLyOSHa9hsPyD00****

IPC设备的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。

注意 如果传入该参数,则无需传入ProductKeyDeviceNameIotId作为设备唯一标识符,和ProductKeyDeviceName的组合是一一对应的关系。如果您同时传入IotIdProductKeyDeviceName的组合,则以IotId为准。
ThumbWidth Integer 100

指定目标缩放图的宽度,单位为px,取值范围为1~4096。

ExpireTime Integer 60

图片URL的失效时间,单位为分钟。

PictureType Integer 1

图片类型:

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

实例ID。

您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。

说明 如果公共实例没有ID值,请参见如何获取实例ID

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

返回数据

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

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data Struct

响应结果。

IotId String 1CJ0***kQi1000000

IPC设备的设备ID。

PicCreateTime Long 1632453652222

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

PicId String R****bVhsNCjMjIy

图片ID。

PicUrl String https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***3D

图片URL。

ThumbUrl String https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***2Cq_90

缩略图URL。

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******
&ThumbWidth=100
&ExpireTime=60
&<公共请求参数>

正常返回示例

XML格式

<QueryDevicePictureFileResponse>
  <RequestId>B6E3F040-F2FD-5B6C-89B2-C3B58D22A5A0</RequestId>
  <Data>
        <IotId>1CJ0***kQi1000000</IotId>
        <ThumbUrl>https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***2Cq_90</ThumbUrl>
        <PicUrl>https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***3D</PicUrl>
        <PicCreateTime>1632453652222</PicCreateTime>
        <PicId>R****bVhsNCjMjIy</PicId>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryDevicePictureFileResponse>

JSON格式

{
    "RequestId": "B6E3F040-F2FD-5B6C-89B2-C3B58D22A5A0",
    "Data": {
        "IotId": "1CJ0***kQi1000000",
        "ThumbUrl": "https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***2Cq_90",
        "PicUrl": "https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***3D",
        "PicCreateTime": 1632453652222,
        "PicId": "R****bVhsNCjMjIy"
    },
    "Code": "200",
    "Success": true
}

错误码

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