本產(chǎn)品（
視圖計算/2018-12-12）的OpenAPI采用RPC簽名風格，簽名細節(jié)參見簽名機制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調用本產(chǎn)品OpenAPI而無需關心技術細節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節(jié)非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（11370001915），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節(jié)請參見獲取AccessKey。
云應用服務管理
| API | 標題 | API概述 |
|---|---|---|
| CreateRenderingInstance | 云應用服務實例創(chuàng)建 | 調用CreateRenderingInstance創(chuàng)建一個云應用服務實例 |
| RenewRenderingInstance | 云應用服務實例續(xù)費 | 調用RenewRenderingInstance續(xù)費一個云應用服務實例 |
| ListRenderingInstances | 查詢云應用服務實例基本信息列表 | 查詢云應用服務實例基本信息列表，支持分頁查詢。 |
| DescribeRenderingInstance | 查詢云應用服務實例詳細信息 | 查詢一個云應用服務實例的詳細信息。 |
| GetRenderingInstanceStreamingInfo | 查詢云應用服務實例流連接信息 | 獲取一個云應用服務實例的流連接信息，每次流化建聯(lián)前都需要調用此接口獲取最新連接信息。 |
| ModifyRenderingInstanceBandwidth | 更新云應用服務實例限速帶寬 | 更新一個云應用服務實例的限速帶寬。 可以通過實例查詢接口DescribeRenderingInstance，獲取限速值與限速更新狀態(tài)。 |
| SendRenderingInstanceCommands | 下發(fā)云應用服務實例控制指令 | 向一個云應用服務實例下發(fā)shell控制指令，并同步響應命令執(zhí)行結果。 本接口不適用于耗時命令。 |
| RebootRenderingInstance | 重啟云應用服務實例 | 重啟一個云應用服務實例。 可通過查詢接口DescribeRenderingInstance獲取重啟進度。 |
| UpdateRenderingInstanceConfiguration | 更新云應用服務實例配置參數(shù) | 更新一個云應用服務實例的配置參數(shù)。支持修改云安卓系統(tǒng)的prop/location/network 等各種配置，構建真機仿真。 可通過實例查詢接口DescribeRenderingInstance，獲取已設置的真機仿真配置值。 查詢實時環(huán)境的配置參數(shù)，參考接口DescribeRenderingInstanceConfiguration。 |
| DescribeRenderingInstanceConfiguration | 查詢云應用服務實例配置信息 | 查詢一個云應用服務實例系統(tǒng)配置的實時信息。 |
| DeleteRenderingInstanceConfiguration | 刪除云應用服務實例的配置設置 | 清除一個云應用服務實例的配置設置。僅可刪除通過UpdateRenderingInstanceConfiguration接口已配置的模塊屬性。 |
| UploadPublicKey | 上傳公鑰 | 上傳一個新的公鑰信息。 |
| ListPublicKeys | 查詢公鑰信息列表 | 查詢滿足條件的公鑰信息列表，支持分頁查詢。 |
| ManageLogin | 云應用服務實例安全登錄管理 | 安全登陸管理。 |
| DeletePublicKey | 刪除公鑰 | 刪除一個指定公鑰。該公鑰關聯(lián)的所有云應用服務實例將自動失效登錄授權。 |
| UploadCloudApp | 上傳應用 | 上傳/上架一個云應用包。 屬于異步接口，可通過ListCloudApps接口查詢上傳進度。 |
| UpdateCloudAppInfo | 更新應用基本信息 | 更新一個云應用的基本信息，如描述信息。 |
| ListCloudApps | 查詢應用列表 | 查詢云應用列表，支持分頁查詢。 |
| InstallCloudApp | 安裝應用 | 安裝一個云應用到一個指定云應用實例。 屬于異步接口，可通過ListCloudAppInstallations接口查詢安裝進度。 |
| UninstallCloudApp | 卸載應用 | 卸載一個指定云應用實例上的一個指定云應用。 屬于異步接口。可通過ListCloudAppInstallations接口查詢卸載進度，卸載成功后，查詢接口將不再輸出相關內容。 |
| ListCloudAppInstallations | 查詢應用安裝信息列表 | 查詢云應用的安裝信息列表，返回信息包括云應用服務實例的安裝狀態(tài)，支持分頁查詢。 |
| DeleteCloudApp | 刪除應用 | 刪除一個云應用。使用中的云應用不允許刪除。 |
| UploadFile | 上傳文件 | 上傳一個文件。基于外鏈URL（公網(wǎng)可下載文件）實現(xiàn)文件上傳到本地/云存儲。 屬于異步操作，可通過ListFiles接口查詢上傳進度。 |
| UpdateFileInfo | 更新文件基本信息 | 更新一個文件的基本信息，如描述信息。 |
| ListFiles | 查詢文件列表 | 查詢上傳的文件列表，返回內容包含文件的上傳狀態(tài)，支持分頁查詢。 |
| PushFile | 推送文件 | 推送一個文件到一個指定云應用服務實例。 屬于異步操作，可通過ListFilePushStatuses接口查詢推送進度。 |
| ListFilePushStatuses | 查詢文件推送狀態(tài)信息列表 | 查詢文件的云應用服務實例推送狀態(tài)信息列表，支持分頁查詢。 |
| DeleteFile | 刪除文件 | 刪除一個文件對象。 文件在上傳/預推中時，不允許刪除。文件刪除后，所有相關的推送記錄將失效，可重新推送同名文件。 |
| ReleaseRenderingInstance | 云應用服務實例釋放 | 調用ReleaseRenderingInstance釋放一個云應用服務實例 |
賬戶
| API | 標題 | API概述 |
|---|---|---|
| DescribeAccountStat | 查詢賬號狀態(tài) | 查詢某個賬號在指定地域下的所有資源信息。 |
空間管理
| API | 標題 | API概述 |
|---|---|---|
| CreateGroup | 創(chuàng)建業(yè)務空間 | 創(chuàng)建新業(yè)務空間。 |
| DeleteGroup | 刪除業(yè)務空間 | 刪除業(yè)務空間，注意：空間需先停用才能刪除。 |
| ModifyGroup | 修改業(yè)務空間 | 修改空間信息。 |
| DescribeGroup | 查詢業(yè)務空間 | 獲取空間信息。 |
| DescribeGroups | 查詢空間列表 | 查詢空間列表。 |
設備管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDevice | 添加設備 | 添加新的設備。 |
| DeleteDevice | 刪除設備 | 需先停止設備再刪除。 |
| BatchDeleteDevices | 批量刪除設備 | 批量刪除設備。 |
| ModifyDevice | 修改設備 | 修改設備信息。 |
| DescribeDevice | 查詢設備 | 查詢設備信息。 |
| DescribeDevices | 查詢設備列表 | 查詢設備列表。 |
| SyncCatalogs | 同步平臺通道 | 同步平臺通道信息。 |
| UnlockDevice | 解鎖設備 | 解鎖設備。 |
| StartDevice | 啟動設備 | 啟動設備拉流，會啟動設備上的所有流。 |
| StopDevice | 停止設備 | 停止設備拉流，會停止設備上的所有流。 |
| BatchStartDevices | 批量啟動設備 | 批量啟動設備拉流。 |
| BatchStopDevices | 批量停止設備 | 批量停止設備拉流。 |
| ModifyDeviceCapture | 修改設備捕獲 | 修改設備圖傳配置。 |
| ModifyDeviceChannels | 修改設備通道 | 更新設備通道列表。 |
| DescribeDeviceChannels | 查詢設備通道列表 | 查詢設備通道列表。 |
| DescribeDeviceGateway | 查詢設備網(wǎng)關 | 查詢設備網(wǎng)關。 |
| DescribeDeviceURL | 查詢設備URL | 查詢設備流的URL信息。 |
| DescribePurchasedDevice | 查詢已購買設備 | 查詢已購買設備信息。 |
| DescribePurchasedDevices | 查詢已購買設備列表 | 查詢已購買設備列表。 |
| BindPurchasedDevice | 綁定已購買設備 | 綁定已購買設備至空間。 |
| UnbindPurchasedDevice | 解綁已購買設備 | 從空間解綁已購買設備。 |
| BatchBindPurchasedDevices | 批量綁定購買設備 | 批量綁定購買設備。 |
| BatchUnbindDirectories | 從目錄內批量解綁多個設備 | 從目錄內批量解綁多個設備。 |
| BatchUnbindPurchasedDevices | 批量解綁已購買設備 | 從空間批量解綁多個已購設備。 |
流管理
| API | 標題 | API概述 |
|---|---|---|
| StartStream | 啟動流 | 啟動流。 |
| StopStream | 停止流 | 停止流。 |
| BatchStartStreams | 批量啟動流 | 批量啟動流。 |
| BatchStopStreams | 批量停止流 | 批量停止流。 |
| DescribeStream | 查詢流詳情 | 查詢流信息。 |
| DescribeStreams | 查詢流列表 | 查詢流的列表信息，支持通過流的ID，名稱，空間ID，設備ID等過濾篩選。 |
| DescribeStreamURL | 獲取流URL | 獲取流URL信息。 |
| ForbidVsStream | 禁止某條流的推送 | 禁止某條流的推送，可以預設某個時刻將流恢復。 |
| ResumeVsStream | 恢復某條流的推送 | 恢復某條流的推送。 |
| BatchForbidVsStream | 批量禁止VS流 | 禁止某條流的推送，可以預設某個時刻將流恢復。 |
| BatchResumeVsStream | 批量恢復某條監(jiān)控流的推送 | 恢復某條流的推送。 |
| CreateStreamSnapshot | 觸發(fā)按需截圖 | 對指定流，按需創(chuàng)建新的截圖。 |
| SetVsStreamsNotifyUrlConfig | 設置 VS 流通知 URL 配置 | 設置推流回調配置。 |
| DeleteVsStreamsNotifyUrlConfig | 刪除推流回調配置 | 刪除推流回調配置。 |
| DescribeVsStreamsNotifyUrlConfig | 獲取 VS 流通知 URL 配置 | 查詢推流回調配置。 |
| AddVsPullStreamInfoConfig | 添加拉流信息配置 | 添加拉流配置信息。 |
| DeleteVsPullStreamInfoConfig | 刪除拉取流信息配置 | 刪除拉流信息。 |
| UpdateVsPullStreamInfoConfig | 更新拉流信息配置 | 更新拉流信息，修改已經(jīng)添加的拉流任務中的源站地址的開始時間和結束時間。 |
| DescribeVsPullStreamInfoConfig | 獲取拉流信息配置 | 查詢域名下拉流配置信息。 |
| DescribeVsStreamsOnlineList | 查詢所有正在推的流的信息 | 查看指定域名下（或者指定域名下某個應用）的所有正在推的流的信息。 |
| DescribeVsStreamsPublishList | 獲取VS流推流記錄 | 獲取某一時間段內某個域名（或域名下某應用或某個流）的推流記錄。 |
模板管理
| API | 標題 | API概述 |
|---|---|---|
| CreateTemplate | 創(chuàng)建模板 | 創(chuàng)建新模板。 |
| DeleteTemplate | 刪除模版 | 刪除模板。 |
| ModifyTemplate | 修改模板 | 修改模板信息。 |
| DescribeTemplate | 查詢模板 | 查詢模板信息。 |
| DescribeTemplates | 查詢模板列表 | 查詢模板列表。 |
| BindTemplate | 綁定模板到指定實例 | 綁定模板到指定的實例，比如：綁定到空間和流的實例。 |
| UnbindTemplate | 解除綁定模板到指定的實例 | 解除綁定模板到指定的實例，比如：解除綁定到空間和流的實例。 |
| BatchBindTemplate | 批量綁定模板到多個實例 | 綁定模板到指定的多個實例，比如：綁定到空間和流的實例。 |
| BatchUnbindTemplate | 批量解除綁定模板到指定的實例 | 解除綁定模板到指定的多個實例，比如：解除綁定到空間和流的實例。 |
| BatchBindTemplates | 批量綁定模板 | 批量綁定模板。 |
| BatchUnbindTemplates | 批量解除綁定模板 | 批量解除綁定模板。 |
錄制管理
| API | 標題 | API概述 |
|---|---|---|
| StartRecordStream | 啟動按需錄制 | 對指定流啟動按需錄制。 |
| StopRecordStream | 停止按需錄制 | 對指定流停止按需錄制。 |
| DescribeRecords | 查詢錄制記錄列表 | 查詢錄制記錄列表。 |
域名管理
| API | 標題 | API概述 |
|---|---|---|
| SetVsDomainCertificate | 設置域名證書信息 | 設置某域名下證書功能是否啟用。 |
| DescribeVsCertificateDetail | 獲取證書詳情 | 獲取證書詳細信息。 |
| DescribeVsDomainCertificateInfo | 獲取指定加速域名證書信息 | 獲取指定加速域名證書信息。 |
| DescribeVsCertificateList | 獲取證書列表 | 獲取域名證書列表信息。 |
| DescribeVsDomainDetail | 查詢域名信息 | 獲取指定視圖計算域名配置的基本信息。 |
| DescribeVsDomainConfigs | 查詢域名配置 | 查詢域名配置，一次可查詢多個功能配置。 |
| BatchSetVsDomainConfigs | 批量配置域名 | 域名批量配置。 |
| BatchDeleteVsDomainConfigs | 域名刪除域名配置 | 批量刪除域名配置。 |
| DescribeVsTopDomainsByFlow | 獲取頂級域名 | 獲取用戶按流量排名的域名 不指定StartTime和EndTime時，默認讀取當月的數(shù)據(jù)，同時支持按指定的起止時間查詢，兩者需要同時指定。 * 最多可獲取90天的數(shù)據(jù)。 |
PTZ管理
| API | 標題 | API概述 |
|---|---|---|
| SetPreset | 設置預置位 | 設置預置位。 |
| GotoPreset | 移動至預置位 | 移動至預置位。 |
| DeletePreset | 刪除預置位 | 刪除預置位。 |
| DescribePresets | 查詢預置位 | 獲取預置位列表。 |
| StopMove | 停止轉動鏡頭 | 停止轉動鏡頭，如水平、垂直、縮放等。 |
| StopAdjust | 停止調節(jié)鏡頭 | 停止調節(jié)鏡頭，如光圈、變焦等。 |
| ContinuousMove | 持續(xù)轉動鏡頭 | 持續(xù)轉動鏡頭，如水平、垂直、縮放等。 |
| ContinuousAdjust | 持續(xù)調節(jié)鏡頭 | 持續(xù)調節(jié)鏡頭，如光圈、變焦等。 |
目錄管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDirectory | 創(chuàng)建目錄 | 創(chuàng)建新的目錄。 |
| DeleteDirectory | 刪除目錄 | 刪除目錄。 |
| ModifyDirectory | 修改目錄 | 修改目錄信息。 |
| DescribeDirectory | 查詢目錄 | 查詢目錄。 |
| DescribeDirectories | 查詢目錄列表 | 查詢目錄列表。 |
| BindDirectory | 綁定設備到目錄 | 綁定設備至目錄。 |
| UnbindDirectory | 從目錄里解綁設備 | 從目錄里解綁設備。 |
| BatchBindDirectories | 批量綁定設備到目錄 | 批量綁定多個設備到目錄。 |
用量查詢
| API | 標題 | API概述 |
|---|---|---|
| DescribeVsDomainPvData | 獲取域名PV數(shù)據(jù) | 獲取域名PV數(shù)據(jù)。 |
| DescribeVsDomainUvData | 獲取 vs 域名 uv 數(shù)據(jù) | 獲取 vs 域名 uv 數(shù)據(jù) 。 |
| DescribeVsDomainPvUvData | 獲取vs域名pv和uv數(shù)據(jù) | 獲取vs域名pv和uv數(shù)據(jù)。 |
| DescribeVsDomainRecordData | 獲取 vs 域名記錄數(shù)據(jù) | 獲取 vs 域名記錄數(shù)據(jù)。 |
| DescribeVsDomainSnapshotData | 獲取域名快照數(shù)據(jù) | 獲取域名快照數(shù)據(jù)。 |
| DescribeVsDomainRegionData | 獲取域名區(qū)域數(shù)據(jù) | 獲取域名區(qū)域數(shù)據(jù)。 |
| DescribeVsDomainBpsData | 查詢域名網(wǎng)絡帶寬監(jiān)控數(shù)據(jù) | 查詢域名網(wǎng)絡帶寬監(jiān)控數(shù)據(jù)。 |
| DescribeVsDomainReqBpsData | 獲取域名網(wǎng)絡請求監(jiān)控數(shù)據(jù) | 獲取域名網(wǎng)絡請求監(jiān)控數(shù)據(jù)。 |
| DescribeVsDomainTrafficData | 獲取域名流量數(shù)據(jù) | 獲取域名流量數(shù)據(jù)。 |
| DescribeVsDomainReqTrafficData | 獲取 vs 域名請求流量數(shù)據(jù) | 獲取 vs 域名請求流量數(shù)據(jù)。 |
| DescribeVsDevicesData | 獲取接入設備用量數(shù)據(jù) | 獲取接入設備用量數(shù)據(jù)。 |
| DescribeVsUpPeakPublishStreamData | 查詢用戶每日上行并發(fā)推流數(shù)峰值 | 查詢用戶的每日上行并發(fā)推流數(shù)峰值。 |
其他
| API | 標題 | API概述 |
|---|---|---|
| VerifyVsDomainOwner | VerifyVsDomainOwner | |
| DescribeVsVerifyContent | DescribeVsVerifyContent | |
| StartPublishStream | StartPublishStream | |
| DescribePublishStreamStatus | DescribePublishStreamStatus | 查詢桌面采集及推流狀態(tài)。 |
| StopPublishStream | StopPublishStream |