API概覽
更新時間 2024-10-16 10:56:43
最近更新時間: 2024-10-16 10:56:43
分享文章
本節主要介紹各個管理模塊的API概覽。
智能視圖服務產品API概覽請參考。
設備管理
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 創建設備 | createDevice | 本接口用于創建設備。 |
| 刪除設備 | deleteDevice | 本接口用于刪除設備。 |
| 修改設備 | modifyDevice | 本接口用于修改設備信息。 |
| 查詢設備 | describeDevice | 本接口用于通過設備ID查詢設備信息。 |
| 查詢設備列表 | describeDevices | 本接口用于查詢設備列表。 |
設備樹管理
目錄管理
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 創建目錄 | createVSSDir | 本接口用于創建目錄。 |
| 刪除目錄 | deleteVSSDir | 本接口用于刪除目錄。 |
| 修改目錄 | modifyVSSDir | 本接口用于修改單個目錄信息。 |
| 查詢目錄 | describeVSSDir | 本接口用于查詢目錄信息。 |
| 查詢目錄列表 | describeVSSDirs | 本接口用于查詢目錄列表。 |
| 修改設備目錄 | bindVSSDir | 本接口用于修改設備的目錄。 |
憑證管理
GB28181憑證
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 創建GB28181憑證 | createGBCert | 本接口用于創建GB28181憑證，該憑證用于GB28181設備注冊。 |
| 刪除GB28181憑證 | deleteGBCert | 本接口用于刪除GB28181憑證。 |
| 更新GB28181憑證 | modifyGBCert | 本接口用于更新GB28181憑證。 |
| 查詢GB28181憑證 | describeGBCert | 本接口用于查詢GB28181憑證信息。 |
| 查詢GB28181憑證列表 | describeGBCerts | 本接口用于查詢GB28181憑證列表。 |
模板管理
視頻存儲模板
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 創建存儲模板 | createRecordTemplate | 本接口用于創建視頻存儲模板，支持配置錄制類型、存儲時長等。 |
| 刪除存儲模板 | deleteRecordTemplate | 本接口用于刪除存儲模板。 |
| 修改存儲模板 | modifyRecordTemplate | 本接口用于修改視頻存儲模板，支持修改錄制類型、存儲時長等。 |
| 查詢存儲模板 | describeRecordTemplate | 本接口用于查詢單個視頻存儲模板的信息。 |
| 查詢存儲模板列表 | describeRecordTemplates | 本接口用于查詢視頻存儲模板列表。 |
| 查詢存儲模板綁定的設備列表 | describeRecordTemplateDevices | 本接口用于查詢存儲模板下綁定的設備列表。 |
視頻設備
視頻設備接入
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 啟用流 | startPush | 本接口用于啟動設備拉流，該操作會啟動設備上的所有流。 |
| 停用流 | stopPush | 本接口用于停止設備拉流，該操作會停止設備上的所有流。 |
視頻流管理
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 查詢設備云端直播流 | descCloudLiveStreams | 本接口用于查詢設備在云端的直播流。 |
視頻存儲管理
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 綁定存儲模板 | bindRecordTemplate | 本接口用于綁定視頻存儲模板至設備。 |
| 解綁存儲模板 | unBindRecordTemplate | 本接口用于解綁設備的視頻存儲模板。 |
| 啟動云端錄制 | startRecordTask | 本接口用于啟動設備的云端錄制。 |
| 停止云端錄制 | stopRecordTask | 本接口用于停止設備的云端錄制。 |
| 查詢設備綁定的存儲模板 | describeDeviceRecordTemplates | 本接口用于查詢設備綁定的視頻存儲模板。 |
| 查詢錄像列表 | describeRecords | 本接口用于查詢設備錄制于云端的錄像文件列表，PlayUrl可用于點播該文件。 |
云臺控制
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 開啟鏡頭轉動 | startDeviceMove | 本接口用于開啟鏡頭轉動，如水平、垂直、縮放（變焦）等。 |
| 停止鏡頭轉動 | stopDeviceMove | 本接口用于停止鏡頭轉動，如水平、垂直、縮放（變焦）等。 |
| 開啟鏡頭調節 | startDeviceAdjust | 本接口用于調節鏡頭聚焦或光圈。 |
| 停止鏡頭調節 | stopDeviceAdjust | 本接口用于停止鏡頭的聚焦或光圈調節。 |
回調管理
回調模板
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 創建回調模板 | createCallbackTemplate | 本接口用于創建回調模板。 |
| 刪除回調模板 | deleteCallbackTemplate | 本接口用于刪除回調模板。 |
| 修改回調模板 | modifyCallbackTemplate | 本接口用于修改回調模板。 |
| 查詢回調模板 | describeCallbackTemplate | 本接口用于查詢單個回調模板的信息。 |
| 查詢回調模板列表 | describeCallbackTemplates | 本接口用于查詢回調模板列表。 |
回調規則
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 創建回調規則 | createCallbackRule | 本接口用于創建回調規則，即綁定回調模板至設備。 |
| 刪除回調規則 | deleteCallbackRule | 本接口用于刪除回調規則，即解綁設備的回調模板。 |
| 查詢回調規則 | describeCallbackRule | 本接口用于查詢回調規則，即查詢設備綁定的回調模板。 |
| 查詢回調規則列表 | describeCallbackRules | 本接口用于查詢回調規則列表，即查詢回調模板綁定的設備列表。 |
計費管理
資源計費
| 功能名稱 | 英文名稱 | 描述 |
|---|---|---|
| 查詢用戶資源列表 | desResourcePkgs | 本接口用于查詢用戶名下有效的資源列表。 |
| 查詢設備資源列表 | describeAttachedResources | 本接口用于查詢指定設備的服務配置列表，包含視頻、視圖和AI配置等。 |
