调用该接口,根据设备ID查询智能告警事件录像计划。

调试

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

请求参数

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

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

IotId String zLZyi6aOLyOSHa9hsPyD00****

要查询的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。

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

StreamType Integer 0

码流类型:

  • 0(默认):主码流
  • 1:辅码流

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

返回数据

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

调用失败时,返回的错误码。更多信息,请参见错误码

Data Struct

查询结果。

Name String planAA

智能告警事件录像名称。

PlanId String 5b60bf0dd55944c19d7817442bc9****

智能告警事件录像计划ID。

PreRecordDuration Integer 5

预录时长,单位秒。

RecordDuration Integer 120

录像时长,包括预录时长,单位为秒。

TemplateId String 36f06322442e4e3f85a5ae8862c9****

时间模板ID。

TemplateInfo Struct

时间模板详情。

AllDay Integer 0

是否7天*24小时录像:

  • 1:是。
  • 0:否,详细配置请查看TimeSectionList参数。
Default Integer 0

时间模板类型:

  • 1:默认模板
  • 0:自定义模板
Name String testtime1

时间模板名称。

TemplateId String 36f06322442e4e3f85a5ae8862c9****

时间模板ID。

TimeSectionList Array of TimeSectionList

时间模板列表。

Begin Integer 0

每天开始的时间,取值范围0~86399,单位为秒。

DayOfWeek Integer 0

每周的周几,取值范围0~6,表示周日~周六。

End Integer 86399

每天结束的时间,取值范围1~86399,单位为秒。

ErrorMessage String tenant auth error

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

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

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryEventRecordPlanDeviceByDevice
&IotId=zLZyi6aOLyOSHa9hsPyD00****
&<公共请求参数>

正常返回示例

XML格式

<QueryEventRecordPlanByDeviceResponse>   
      <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
      <Success>true</Success>
      <Data>
            <PlanId>5b60bf0dd55944c19d7817442bc9****</PlanId>
            <Name>planAA</Name>
            <PreRecordDuration>5</PreRecordDuration>
            <RecordDuration>120</RecordDuration>
            <TemplateId>36f06322442e4e3f85a5ae8862c9****</TemplateId>
            <TemplateInfo>
                  <TemplateId>36f06322442e4e3f85a5ae8862c9****</TemplateId>
                  <Name>testtime1</Name>
                  <AllDay>0</AllDay>
                  <Default>0</Default>
                  <TimeSectionList>
                        <DayOfWeek>1</DayOfWeek>
                        <Begin>0</Begin>
                        <End>86399</End>
                  </TimeSectionList>
                  <TimeSectionList>
                        <DayOfWeek>5</DayOfWeek>
                        <Begin>0</Begin>
                        <End>40000</End>
                  </TimeSectionList>
            </TemplateInfo>
      </Data>
</QueryEventRecordPlanByDeviceResponse>

JSON格式

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Success": true,
    "Data": {
        "PlanId": "5b60bf0dd55944c19d7817442bc9****",
        "Name": "planAA",
        "PreRecordDuration": 5,
        "RecordDuration": 120,
        "TemplateId": "36f06322442e4e3f85a5ae8862c9****",
        "TemplateInfo": {
            "TemplateId": "36f06322442e4e3f85a5ae8862c9****",
            "Name": "testtime1",
            "AllDay": 0,
            "Default": 0,
            "TimeSectionList": [
                {
                    "DayOfWeek": 1,
                    "Begin": 0,
                    "End": 86399
                },
                {
                    "DayOfWeek": 5,
                    "Begin": 0,
                    "End": 40000
                }
            ]
        }
    }
}

错误码

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