启动云端录制
最近更新时间:2026-03-19 18:16:28
天翼云智能视图服务API
1.启动云端录制
接口功能介绍
本接口用于启动设备的云端录制。
接口约束
仅设备绑定的视频录制模板为手动录制时,可以手动启用云端录制。
URI
PUT /devices/{DeviceId}/records/startCloudRecord
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| DeviceId | 是 | String | 设备ID。 | 32388487739092996 |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Authorization | 是 | String | 认证信息。 | CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f | |
| Content-Type | 是 | String | 互联网媒体类型。 | application/json;charset=utf-8 | |
| Host | 是 | String | 主机。 | vssapi.ctyun.cn | |
| Version | 是 | String | 版本。 | 2021-11-25 | |
| Timestamp | 是 | String | 时间戳。 | 1689643309 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| StreamNum | 否 | Integer | 第几个码流,默认主码流,gb28181和rtmp设备仅支持主码流。取值:1:主码流;2:子码流;3:第三码流。 | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。 | 200 | |
| error | String | 错误码,执行成功时,不返回该字段。 | VSS_0001 | |
| message | String | 响应信息。 | 请求成功 | |
| requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 响应数据,执行失败时,不返回该字段。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| RecordTaskId | String | 录制任务 ID,全局唯一标识录制任务。 | 725245970006753281 | |
| CreatedTime | String | 录制任务创建时间。 | 2023-05-06 15:29:18 | |
| UpdatedTime | String | 录制任务更新时间。 | 2023-05-06 15:59:53 | |
| RequestId | String | 请求ID。 | 4a76b6697563462dbe99955b9d5140c9 |
请求示例
请求url
PUT '/devices/32388487739092996/records/startCloudRecord'
请求头header
{
"Authorization": "CT-HMAC-SHA256 Credential=FVAQ9J9SQXS3P37SXDPT/2023-05-06/vss, SignedHeaders=content-type;host;timestamp, Signature=342d482df09344924d286ef5f7b25c4398f93a5d6326648343fd72d922e43fb8",
"Content-Type": "application/json;charset=utf-8",
"Host": "vssapi.ctyun.cn",
"Version": "2021-11-25",
"Timestamp": "1683359977"
}
请求体body
无
响应示例
{
"statusCode": 200,
"message": "请求成功",
"requestId": "4a76b6697563462dbe99955b9d5140c9",
"returnObj": {
"RecordTaskId": "725245970006753281",
"CreatedTime": "2023-05-06 15:29:18",
"UpdatedTime": "2023-05-06 15:59:53",
"RequestId": "4a76b6697563462dbe99955b9d5140c9"
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
本页目录: