调用该接口获取图片列表。

使用限制

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

调试

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

请求参数

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

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

BeginTime Long 1615357669000

检索范围起始时间,格式为13位时间戳,单位为毫秒。

EndTime Long 1615444063000

检索范围结束时间,格式为13位时间戳,单位为毫秒。

IotId String zLZyi6aOLyOSHa9hsPyD00****

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

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

CurrentPage Integer 1

指定从返回结果中的第几页开始显示。页数从1开始排序。

PageSize Integer 10

每页显示的条数。

默认值为10,最大值为50。

PictureType Integer 2

图片类型:

  • 0:缩略图
  • 1:原图
  • 2:全部

默认值为2。

PictureSource Integer 0

图片来源:

  • 0:全部事件
  • 1:告警事件抓图
  • 2:主动抓图
  • 3:其他

默认值为0。

IotInstanceId String iot-cn-n6w1y****

实例ID。

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

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

返回数据

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

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

Data Struct

响应结果。

List Array of List

返回的图片列表。

IotId String zLZyi6aOLyOSHa9hsPyD00****

摄像机ID。

PicCreateTime Long 1543458157522

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

PicId String pZJUqijOyfpFOOGNP******

图片ID。

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

原图URL。

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

缩略图URL。

说明 URL有效期为1小时。
Page Integer 1

当前页面号。

PageSize Integer 10

每页显示的条数。

ErrorMessage String XXXis mandatory for this action

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

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

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryPictureFiles
&BeginTime=1615357669000
&EndTime=1615444063000
&IotId=zLZyi6aOLyOSHa9hsPyD00****
&IotInstanceId=iot-cn-n6w1y****
&<公共请求参数>

正常返回示例

XML格式

<QueryPictureFilesResponse>
  <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
  <Data>
        <PageSize>10</PageSize>
        <Page>1</Page>
        <List>
              <IotId>zLZyi6aOLyOSHa9hsPyD00****</IotId>
              <ThumbUrl>http://***.jpg</ThumbUrl>
              <PicUrl>http://***_normal.jpg</PicUrl>
              <PicId>pZJUqijOyfpFOOGNP******</PicId>
              <PicCreateTime>1543458157522</PicCreateTime>
        </List>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryPictureFilesResponse>

JSON格式

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Data": {
        "PageSize": "10",
        "Page": "1",
        "List": [
            {
                "IotId": "zLZyi6aOLyOSHa9hsPyD00****",
                "ThumbUrl": "http://***.jpg",
                "PicUrl": "http://***_normal.jpg",
                "PicId": "pZJUqijOyfpFOOGNP******",
                "PicCreateTime": "1543458157522"
            }
        ]
    },
    "Code": "200",
    "Success": "true"
}

错误码

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