Queries the images of an IP camera.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryPictureFiles

The operation that you want to perform. Set the value to QueryPictureFiles.

BeginTime Long Yes 1615357669000

The beginning of the time range to query. The value is a 13-digit timestamp in milliseconds.

EndTime Long Yes 1615444063000

The end of the time range to query. The value is a 13-digit timestamp in milliseconds.

ProductKey String No a1BwAGV****

The ProductKey of the product to which the IP camera belongs.

You can view the information about all products within the current account on the Products page of the IoT Platform console or by calling the QueryProductList operation.

Notice If you specify this parameter, you must also specify the DeviceName parameter.
DeviceName String No camera1

The DeviceName of the IP camera.

You can view the DeviceName of the IP camera on the Devices page of the IoT Platform console.

Notice If you specify this parameter, you must also specify the ProductKey parameter.
IotId String No zLZyi6aOLyOSHa9hsPyD00****

The ID of the IP camera. IoT Platform allocates an ID to each IP camera to uniquely identify the IP camera. You can call the QueryDeviceDetail operation of IoT Platform to query the ID of the IP camera.

Notice If you specify this parameter, you do not need to specify the ProductKey or DeviceName parameter. The IotId parameter specifies a GUID of the IP camera, which corresponds to a combination of the ProductKey and DeviceName parameters. If you specify both the IotId parameter and the combination of the ProductKey and DeviceName parameters, the IotId parameter takes precedence.
CurrentPage Integer No 1

The number of the page to return. Pages start from page 1.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. A maximum of 50 entries can be returned on each page.

PictureType Integer No 2

The type of the image. Valid values:

  • 0: thumbnail.
  • 1: source image.
  • 2: thumbnail and source image. This is the default value.
PictureSource Integer No 0

The source of the image. Valid values:

  • 0: all sources. This is the default value.
  • 1: alert event-triggered image capture.
  • 2: manually triggered image capture.
  • 3: other sources.
IotInstanceId String No iot-cn-n6w1y****

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String 200

The response code.

  • 200: The call was successful.
  • Other codes: The call failed. For more information about error codes, see Error codes.
Data Struct

The response.

List Array of List

The returned images.

IotId String zLZyi6aOLyOSHa9hsPyD00****

The ID of the IP camera.

PicCreateTime Long 1543458157522

The time when the image was created. The value is a 13-digit timestamp in milliseconds.

PicId String pZJUqijOyfpFOOGNP******

The ID of the image.

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

The URL of the image.

Note The URL is valid for 1 hour.
ThumbUrl String http://***.jpg

The URL of the thumbnail.

Note The URL is valid for 1 hour.
Page Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

ErrorMessage String product is not active.

The error message returned if the call failed.

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

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryPictureFiles
&BeginTime=1615357669000
&EndTime=1615444063000
&IotId=zLZyi6aOLyOSHa9hsPyD00****
&IotInstanceId=iot-cn-n6w1y****
&<Common request parameters>

Sample success responses

XML format 

<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 format 

{
    "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
}

Error codes

For a list of error codes, visit the API Error Center.