1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
开通云存服务
默认接口请求频率限制:5000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCloudStorage。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProductId | 是 | String | 产品ID 示例值:H541SOP191 |
DeviceName | 是 | String | 设备名称 示例值:event_36502632_1 |
PackageId | 是 | String | 云存套餐ID: yc1m3d : 全时3天存储月套餐。 yc1m7d : 全时7天存储月套餐。 yc1m30d :全时30天存储月套餐。 yc1y3d :全时3天存储年套餐。 yc1y7d :全时7天存储年套餐。 yc1y30d :全时30天存储年套餐。 ye1m3d :事件3天存储月套餐。 ye1m7d :事件7天存储月套餐。 ye1m30d :事件30天存储月套餐 。 ye1y3d :事件3天存储年套餐。 ye1y7d :事件7天存储年套餐。 ye1y30d :事件30天存储年套餐。 yc1w7d : 全时7天存储周套餐。 ye1w7d : 事件7天存储周套餐。 lye1m3d:低功耗事件3天月套餐。 lye1m7d:低功耗事件7天月套餐。 lye1m30d:低功耗事件30天月套餐。 lye1y3d:低功耗事件3天年套餐。 lye1y7d:低功耗事件7天年套餐。 lye1y30d:低功耗事件30天年套餐。 示例值:yc1m3d |
Override | 否 | Integer | 如果当前设备已开启云存套餐,Override=1会使用新套餐覆盖原有套餐。不传此参数则默认为0。 示例值:0 |
PackageQueue | 否 | String | 套餐列表顺序:PackageQueue=front会立即使用新购买的套餐,新购套餐结束后,列表中下一个未过期的套餐继续生效;PackageQueue=end会等设备当前所有已购买套餐过期后才会生效新购套餐。与Override参数不能同时使用。 示例值:front |
OrderId | 否 | String | 订单id 示例值:slfie21321 |
ChannelId | 否 | Integer | 通道ID 示例值:1 |
StorageRegion | 否 | String | 云存视频存储区域,国内默认为ap-guangzhou。海外默认为东南亚ap-singapore,可选美东na-ashburn、欧洲eu-frankfurt。 示例值:ap-guangzhou |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 CreateCloudStorage
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudStorage
<公共请求参数>
{
"ProductId": "H541SOP191",
"DeviceName": "event_36502632_1",
"PackageId": "yc1m3d"
}
输出示例
{
"Response": {
"RequestId": "a9a9d232-01c0-494a-baa3-57c384463c3f"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
UnsupportedOperation | 操作不支持。 |