调用该接口,获取触发智能告警事件时,IPC设备拍摄上传的图片。

调试

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

请求参数

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

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

EventId String ae6b74f1dc7d402****32c21018****f1608036****71

智能告警事件ID。通过QueryDeviceEvent接口获取。

ProductKey String a1BwAGV****

IPC设备所属产品的ProductKey。

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

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

IPC设备的设备名称。

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

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

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

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

实例ID。

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

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

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

返回数据

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

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data String oss://***/***.jpg

图片地址。

ErrorMessage String product is not active

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

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

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryDeviceEventPicture
&EventId=ae6b74f1dc7d402****32c21018****f1608036****71
&IotId=zLZyi6aOLyOSHa9hsPyD00****
&<公共请求参数>

正常返回示例

XML格式

<QueryDeviceEventPictureResponse>
    <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
    <Code>200</Code>
    <Success>true</Success>
    <Data>
      oss://***/***.jpg
  </Data>
</QueryDeviceEventPictureResponse>

JSON格式

{
    "QueryDeviceEventPictureResponse": {
        "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
        "Code": "200",
        "Success": true,
        "Data": "oss://***/***.jpg"
    }
}

错误码

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