获取全部录制计划

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

我的收藏

1. 接口描述

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

本接口(DescribeRecordingPlans)用于获取用户的全部录制计划。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRecordingPlans。
Version String 公共参数,本接口取值:2020-12-01。
Region String 公共参数,详见产品支持的 地域列表

3. 输出参数

参数名称 类型 描述
Plans Array of RecordPlanDetail 录制计划详情·列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 录制计划总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取录制计划列表

输入示例

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

{}

输出示例

{
    "Response": {
        "Plans": [
            {
                "PlanId": "plan-fyw1k9l5",
                "Name": "arvinxu_test",
                "TimeTemplateId": "tgrp-jfs89ahg",
                "TimeTemplateName": "全天候模板",
                "Channels": [
                    {
                        "DeviceId": "99576636581320000330_99576636581320000330",
                        "ChannelId": "99576636581320000330_99576636581320000330"
                    }
                ],
                "RecordStorageTime": 5
            },
            {
                "PlanId": "plan-c8obq4v0",
                "Name": "xx",
                "TimeTemplateId": "tgrp-fmwq1f1a",
                "TimeTemplateName": "工作日模板",
                "Channels": [],
                "RecordStorageTime": 3
            }
        ],
        "RequestId": "c70e67c3-c244-4b25-8518-1bdee3ccacab",
        "TotalCount": 2
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码