接口功能介绍
本接口用于启动设备的云端录制。
接口约束
仅设备绑定的视频录制模板为手动录制且设备和流在线时，可以手动启用云端录制。
请求参数说明：
String类型的参数，传""等同于不传。
Integer类型的参数，传0等同于不传。
Boolean类型的参数，传false等同于不传。
URI
PUT /v2/devices/*/records/startCloudRecord
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| DeviceId | 是 | String | 设备ID。 | 32388487739092996 |
Query参数
无
请求参数
请求头header参数
无
请求体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 '/v2/devices/32388487739092996/records/startCloudRecord'
请求头header
无
请求体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"}}
状态码
请参考 状态码
错误码
请参考 错误码
