1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
批量添加截图配置的通道
默认接口请求频率限制:5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:BatchAddVideoSnapshotConfigChannel。 |
| Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ConfigId | 是 | String | 截图配置Id 示例值:b8ab5-53***07daafd74 |
| Channels.N | 否 | Array of String | 通道Id列表 示例值:["d436***5492cfaa7"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchAddVideoSnapshotConfigChannel
<公共请求参数>
{
"ConfigId": "b8ab**5*-*5*3**************07daafd74",
"Channels": [
"d436***********************5492cfaa7"
]
}
输出示例
{
"Response": {
"RequestId": "e6bef3e1-5a6d-4a2d-a63d-90c06ff75226"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败 |
| InvalidParameterValue.ContainInvalidChannelId | 包含无效的ChannelId |
| InvalidParameterValue.ContainInvalidSnapshotTime | 包含无效的截图时间段 |
| InvalidParameterValue.InvalidConfigId | 无效的配置ID |
| LimitExceeded.BatchAddChannelNumExceeded | 单次批量添加到配置中的通道数超出限制 |
| LimitExceeded.ChannelNumExceeded | 通道数量超出限制 |
| OperationDenied.ConfigChanging | 配置正在变更中,请稍后重试 |
| OperationDenied.InputDuplicateChannelId | 检测到重复的通道ID |
| ResourceNotFound | 资源不存在 |
| ResourceNotFound.AccessUnauthorized | 无法访问未经授权的设备 |
| ResourceNotFound.SnapshotConfigNotExist | 截图配置不存在 |