调用该接口根据设备ID,查询该视频设备的录像计划。

调试

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

请求参数

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

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

IotId String zLZyi6aOLyOSHa9hsPyD00****

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

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

StreamType Integer 0

码流类型:

  • 0:主码流
  • 1:辅码流

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

返回数据

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

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

Data Struct

录像计划信息。

Name String test

录像计划模板名称。

PlanId String 5b60bf0dd55944c19d7817442bc9****

录像计划ID。

TemplateId String 693e244a038f4255bb2f5db32874****

录像计划关联的时间模板ID。

TemplateInfo Struct

时间模板信息。

AllDay Integer 1

是否7天*24小时录像:

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

模板类型:

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

时间模板名称。

TemplateId String 693e244a038f4255bb2f5db32874****

时间模板ID。

TimeSectionList Array of TimeSectionList

时间模板信息。

Begin Integer 6000

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

DayOfWeek Integer 0

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

End Integer 20000

每天结束的时间,取值范围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=QueryRecordPlanDeviceByDevice
&IotId=zLZyi6aOLyOSHa9hsPyD00****
&StreamType=0
&<公共请求参数>

正常返回示例

XML格式

<QueryRecordPlanByDeviceResponse> 
  <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
  <Data>
        <PlanId>5b60bf0dd55944c19d7817442bc9****</PlanId>
        <TemplateId>693e244a038f4255bb2f5db32874****</TemplateId>
        <Name>test</Name>
        <TemplateInfo>
              <AllDay>0</AllDay>
              <Default>0</Default>
              <TemplateId>693e244a038f4255bb2f5db32874****</TemplateId>
              <Name>test</Name>
              <TimeSectionList>
                    <DayOfWeek>0</DayOfWeek>
                    <Begin>6000</Begin>
                    <End>20000</End>
              </TimeSectionList>
        </TemplateInfo>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryRecordPlanByDeviceResponse>

JSON格式

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Data": {
        "PlanId": "5b60bf0dd55944c19d7817442bc9****",
        "TemplateId": "693e244a038f4255bb2f5db32874****",
        "Name": "test",
        "TemplateInfo": {
            "AllDay": "0",
            "Default": "0",
            "TemplateId": "693e244a038f4255bb2f5db32874****",
            "Name": "test",
            "TimeSectionList": [
                {
                    "DayOfWeek": 0,
                    "Begin": "6000",
                    "End": "20000"
                }
            ]
        }
    },
    "Code": "200",
    "Success": "true"
}

错误码

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