停用流
更新時間 2024-09-11 16:11:27
最近更新時間: 2024-09-11 16:11:27
分享文章
接口功能介紹
本接口用于停止設備拉流,該操作會停止設備上的所有流。
接口約束
停止實時推流前確保設備和流在線。
請求參數說明:
String類型的參數,傳""等同于不傳。
Integer類型的參數,傳0等同于不傳。
Boolean類型的參數,傳false等同于不傳。
URI
PUT /v2/devices/*/stopPlay
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| DeviceId | 是 | String | 設備ID。 | 32388487739092996 |
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼,執行成功時,不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據,執行失敗時,不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| DeviceId | String | 設備ID。 | 713412235594514432 | |
| CreatedTime | String | 停止設備拉流任務創建時間。 | 2023-04-20 18:24:42 | |
| UpdatedTime | String | 停止設備拉流任務更新時間。 | 2023-04-20 18:24:42 | |
| RequestId | String | 請求ID。 | 2b531b99af7c488d8df4100bd9d63fad |
枚舉參數
無
請求示例
請求url
PUT /v2/devices/713412235594514432/stopPlay
請求頭header
無
請求體body
無
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "2b531b99af7c488d8df4100bd9d63fad","returnObj": {"DeviceId": "713412235594514432","CreatedTime": "2023-04-20 18:24:42","UpdatedTime": "2023-04-20 18:24:42","RequestId": "2b531b99af7c488d8df4100bd9d63fad"}}
狀態碼
請參考
錯誤碼
請參考