创建场景

最近更新时间:2024-03-12 01:35:45

我的收藏

1. 接口描述

接口请求域名: iotvideoindustry.tencentcloudapi.com 。

创建场景

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateScene。
Version String 公共参数,本接口取值:2020-12-01。
Region String 公共参数,详见产品支持的 地域列表
SceneName String 场景名称
示例值:告警录制
SceneTrigger String 场景触发规则
示例值:{"2":{"Name":"设备报警","WarnType":{"1":"视频丢失报警","2":"设备防拆报警","3":"存
RecordDuration Integer 录制时长 (秒)
示例值:3600
StoreDuration Integer 录像存储时长(天)
示例值:30
Devices.N Array of DeviceItem 设备列表(不推荐使用)
Channels.N Array of ChannelItem 通道列表

3. 输出参数

参数名称 类型 描述
IntId Integer 场景ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建场景

输入示例

POST / HTTP/1.1
Host: iotvideoindustry.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateScene
<公共请求参数>

{
    "SceneName": "测试场景",
    "SceneTrigger": "{\"2\":{\"Name\":\"设备报警\",\"WarnType\":{\"1\":\"视频丢失报警\",\"2\":\"设备防拆报警\",\"3\":\"存储设备磁盘满报警\",\"4\":\"设备高温报警\",\"5\":\"设备低温报警\"}}}",
    "RecordDuration": 360,
    "StoreDuration": 2
}

输出示例

{
    "Response": {
        "IntId": 2,
        "RequestId": "1d7a62c9-db36-4a5f-9209-2e420883e28f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.DBOperationError DB操作错误。