调用该接口查询设备的时间模板信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryTimeTemplate |
系统规定参数。取值:QueryTimeTemplate。 |
PageSize | Integer | 否 | 10 |
每页显示的条数。最小值为1,最大值为50,默认值为10。 |
CurrentPage | Integer | 否 | 1 |
指定从返回结果中的第几页开始显示。页数从1开始排序。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | 200 |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct |
调用成功时,返回时间模板信息。 |
|
List | Array of List |
返回的模板列表。 |
|
AllDay | Integer | 1 |
是否7天*24小时录像:
|
Default | Integer | 1 |
是否是默认模板:
|
Name | String | exampleName |
时间模板名称。 |
TemplateId | String | adxxx |
时间模板ID。 |
TimeSectionList | Array of TimeSectionList |
时间模板信息。 |
|
Begin | Integer | 20000 |
每天开始的时间,单位为秒。 |
DayOfWeek | Integer | 0 |
每周的周几,取值范围0~6,表示周日~周六。 |
End | Integer | 60000 |
每天结束的时间,单位为秒。 |
Page | Integer | 1 |
当前页面号。 |
PageCount | Integer | 1 |
总页数。 |
PageSize | Integer | 10 |
每页显示的条数。 |
Total | Integer | 1 |
总条数。 |
ErrorMessage | String | tenant auth error |
调用失败时,返回的出错信息。 |
RequestId | String | 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
是否调用成功:
|
示例
请求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryTimeTemplate
&CurrentPage=1
&PageSize=10
&<公共请求参数>
正常返回示例
XML
格式
<QueryTimeTemplateResponse>
<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
<Data>
<Total>2</Total>
<PageCount>1</PageCount>
<Page>1</Page>
<PageSize>10</PageSize>
<List>
<TemplateId>joijoz***</TemplateId>
<Name>testtime1</Name>
<AllDay>0</AllDay>
<Default>0</Default>
<TimeSectionList>
<DayOfWeek>0</DayOfWeek>
<Begin>20000</Begin>
<End>60000</End>
</TimeSectionList>
<TimeSectionList>
<DayOfWeek>1</DayOfWeek>
<Begin>20000</Begin>
<End>60000</End>
</TimeSectionList>
</List>
<List>
<TemplateId>joijoz***</TemplateId>
<Name>testtime2</Name>
<AllDay>0</AllDay>
<Default>0</Default>
<TimeSectionList>
<DayOfWeek>1</DayOfWeek>
<Begin>20000</Begin>
<End>60000</End>
</TimeSectionList>
<TimeSectionList>
<DayOfWeek>2</DayOfWeek>
<Begin>20000</Begin>
<End>60000</End>
</TimeSectionList>
</List>
</Data>
</QueryTimeTemplateResponse>
JSON
格式
{
"RequestId":"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
"Data": {
"Total": 2,
"PageCount": 1,
"Page": 1,
"PageSize":10,
"List": [{
"TemplateId": "joijoz***",
"Name": "testtime1",
"AllDay": 0,
"Default": 0,
"TimeSectionList": [{
"DayOfWeek": 0,
"Begin": 20000,
"End": 60000
},
{
"DayOfWeek": 1,
"Begin": 20000,
"End": 60000
}
]
},
{
"TemplateId": "joijoz***",
"Name": "testtime2",
"AllDay": 0,
"Default": 0,
"TimeSectionList": [{
"DayOfWeek": 1,
"Begin": 20000,
"End": 60000
},
{
"DayOfWeek": 2,
"Begin": 20000,
"End": 60000
}
]
}
]
}
}
错误码
访问错误中心查看更多错误码。