调用该接口查询指定时间模板的详情信息。

调试

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

请求参数

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

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

TemplateId String 36f06322442e4e3f85a5ae8862c9****

时间模板ID。可调用QueryTimeTemplate查询。

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

返回数据

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

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data Struct

调用成功时,返回时间模板信息。

AllDay Integer 0

是否7天*24小时录像:

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

是否是默认模板:

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

时间模板名称。

TemplateId String 36f06322442e4e3f85a5ae8862c9****

时间模板ID。

TimeSectionList Array of TimeSectionList

时间模板信息。

Begin Integer 20000

每天开始的时间,单位为秒。

DayOfWeek Integer 0

时间。取值0~6,表示周日~周六。

End Integer 60000

每天结束的时间,单位为秒。

ErrorMessage String template owner error

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

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

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryTimeTemplateDetail
&TemplateId=36f06322442e4e3f85a5ae8862c9****
&<公共请求参数>

正常返回示例

XML格式

<QueryTimeTemplateDetailResponse>
  <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
  <Data>
        <AllDay>0</AllDay>
        <Default>0</Default>
        <TemplateId>36f06322442e4e3f85a5ae8862c9****</TemplateId>
        <Name>test</Name>
        <TimeSectionList>
              <DayOfWeek>0</DayOfWeek>
              <Begin>20000</Begin>
              <End>60000</End>
        </TimeSectionList>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryTimeTemplateDetailResponse>

JSON格式

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Data": {
        "AllDay": 0,
        "Default": 0,
        "TemplateId": "36f06322442e4e3f85a5ae8862c9****",
        "Name": "test",
        "TimeSectionList": [
            {
                "DayOfWeek": 0,
                "Begin": 20000,
                "End": 60000
            }
        ]
    },
    "Code": "200",
    "Success": "true"
}

错误码

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