调用该接口获取图片列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryPictureFiles |
系统规定参数。取值:QueryPictureFiles。 |
BeginTime | Long | 是 | 1615357669000 |
检索范围起始时间,格式为13位时间戳,单位为毫秒。 |
EndTime | Long | 是 | 1615444063000 |
检索范围结束时间,格式为13位时间戳,单位为毫秒。 |
ProductKey | String | 否 | a1BwAGV**** |
IPC设备所属产品的ProductKey。 您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。 注意 如果传入该参数,需同时传入DeviceName。
|
DeviceName | String | 否 | camera1 |
IPC设备的设备名称。 您可以在物联网平台控制台的设备页查看DeviceName。 注意 如果传入该参数,需同时传入ProductKey。
|
IotId | String | 否 | zLZyi6aOLyOSHa9hsPyD00**** |
IPC设备的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。 注意 如果传入该参数,则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符,和ProductKey与DeviceName的组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName的组合,则以IotId为准。
|
CurrentPage | Integer | 否 | 1 |
指定从返回结果中的第几页开始显示。页数从1开始排序。 |
PageSize | Integer | 否 | 10 |
每页显示的条数。默认值为10,最大值为50。 |
PictureType | Integer | 否 | 2 |
图片类型:
|
PictureSource | Integer | 否 | 0 |
图片来源:
|
IotInstanceId | String | 否 | iot-cn-n6w1y**** |
实例ID。 您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。 说明 如果公共实例没有ID值,请参见如何获取实例ID。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | 200 |
接口返回码:
|
Data | Struct |
响应结果。 |
|
List | Array of List |
返回的图片列表。 |
|
IotId | String | zLZyi6aOLyOSHa9hsPyD00**** |
IPC设备的设备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 | product is not active. |
调用失败时,返回的出错信息。 |
RequestId | String | 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
是否调用成功:
|
示例
请求示例
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
}
错误码
访问错误中心查看更多错误码。