AI 助理
备案控制台
文档
输入文档关键字查找
首页 视图计算 开发参考 API参考 API概览

API概览

更新时间：
产品详情
我的收藏
本产品（视图计算/2018-12-12）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

云应用服务管理

API标题API概述
CreateRenderingInstance云应用服务实例创建调用CreateRenderingInstance创建一个云应用服务实例
RenewRenderingInstance云应用服务实例续费调用RenewRenderingInstance续费一个云应用服务实例
ListRenderingInstances查询云应用服务实例基本信息列表查询云应用服务实例基本信息列表，支持分页查询。
DescribeRenderingInstance查询云应用服务实例详细信息查询一个云应用服务实例的详细信息。
GetRenderingInstanceStreamingInfo查询云应用服务实例流连接信息获取一个云应用服务实例的流连接信息，每次流化建联前都需要调用此接口获取最新连接信息。
ModifyRenderingInstanceBandwidth更新云应用服务实例限速带宽更新一个云应用服务实例的限速带宽。 可以通过实例查询接口DescribeRenderingInstance，获取限速值与限速更新状态。
SendRenderingInstanceCommands下发云应用服务实例控制指令向一个云应用服务实例下发shell控制指令，并同步响应命令执行结果。 本接口不适用于耗时命令。
RebootRenderingInstance重启云应用服务实例重启一个云应用服务实例。 可通过查询接口DescribeRenderingInstance获取重启进度。
UpdateRenderingInstanceConfiguration更新云应用服务实例配置参数更新一个云应用服务实例的配置参数。支持修改云安卓系统的prop/location/network 等各种配置，构建真机仿真。 可通过实例查询接口DescribeRenderingInstance，获取已设置的真机仿真配置值。 查询实时环境的配置参数，参考接口DescribeRenderingInstanceConfiguration。
DescribeRenderingInstanceConfiguration查询云应用服务实例配置信息查询一个云应用服务实例系统配置的实时信息。
DeleteRenderingInstanceConfiguration删除云应用服务实例的配置设置清除一个云应用服务实例的配置设置。仅可删除通过UpdateRenderingInstanceConfiguration接口已配置的模块属性。
UploadPublicKey上传公钥上传一个新的公钥信息。
ListPublicKeys查询公钥信息列表查询满足条件的公钥信息列表，支持分页查询。
ManageLogin云应用服务实例安全登录管理安全登陆管理。
DeletePublicKey删除公钥删除一个指定公钥。该公钥关联的所有云应用服务实例将自动失效登录授权。
UploadCloudApp上传应用上传/上架一个云应用包。 属于异步接口，可通过ListCloudApps接口查询上传进度。
UpdateCloudAppInfo更新应用基本信息更新一个云应用的基本信息，如描述信息。
ListCloudApps查询应用列表查询云应用列表，支持分页查询。
InstallCloudApp安装应用安装一个云应用到一个指定云应用实例。 属于异步接口，可通过ListCloudAppInstallations接口查询安装进度。
UninstallCloudApp卸载应用卸载一个指定云应用实例上的一个指定云应用。 属于异步接口。可通过ListCloudAppInstallations接口查询卸载进度，卸载成功后，查询接口将不再输出相关内容。
ListCloudAppInstallations查询应用安装信息列表查询云应用的安装信息列表，返回信息包括云应用服务实例的安装状态，支持分页查询。
DeleteCloudApp删除应用删除一个云应用。使用中的云应用不允许删除。
UploadFile上传文件上传一个文件。基于外链URL（公网可下载文件）实现文件上传到本地/云存储。 属于异步操作，可通过ListFiles接口查询上传进度。
UpdateFileInfo更新文件基本信息更新一个文件的基本信息，如描述信息。
ListFiles查询文件列表查询上传的文件列表，返回内容包含文件的上传状态，支持分页查询。
PushFile推送文件推送一个文件到一个指定云应用服务实例。 属于异步操作，可通过ListFilePushStatuses接口查询推送进度。
ListFilePushStatuses查询文件推送状态信息列表查询文件的云应用服务实例推送状态信息列表，支持分页查询。
DeleteFile删除文件删除一个文件对象。 文件在上传/预推中时，不允许删除。文件删除后，所有相关的推送记录将失效，可重新推送同名文件。
CreateRenderingInstanceGateway创建自定义网关创建自定义网关。
ListRenderingInstanceGateway查询自定义网关查询自定义网关。
DeleteRenderingInstanceGateway删除自定义网关删除自定义网关。
ReleaseRenderingInstance云应用服务实例释放调用ReleaseRenderingInstance释放一个云应用服务实例

账户

API标题API概述
DescribeAccountStat查询账号状态查询某个账号在指定地域下的所有资源信息。

空间管理

API标题API概述
CreateGroup创建业务空间创建新业务空间。
DeleteGroup删除业务空间删除业务空间，注意：空间需先停用才能删除。
ModifyGroup修改业务空间修改空间信息。
DescribeGroup查询业务空间获取空间信息。
DescribeGroups查询空间列表查询空间列表。

设备管理

API标题API概述
CreateDevice添加设备添加新的设备。
DeleteDevice删除设备需先停止设备再删除。
BatchDeleteDevices批量删除设备批量删除设备。
ModifyDevice修改设备修改设备信息。
DescribeDevice查询设备查询设备信息。
DescribeDevices查询设备列表查询设备列表。
SyncCatalogs同步平台通道同步平台通道信息。
UnlockDevice解锁设备解锁设备。
StartDevice启动设备启动设备拉流，会启动设备上的所有流。
StopDevice停止设备停止设备拉流，会停止设备上的所有流。
BatchStartDevices批量启动设备批量启动设备拉流。
BatchStopDevices批量停止设备批量停止设备拉流。
ModifyDeviceCapture修改设备捕获修改设备图传配置。
ModifyDeviceChannels修改设备通道更新设备通道列表。
DescribeDeviceChannels查询设备通道列表查询设备通道列表。
DescribeDeviceGateway查询设备网关查询设备网关。
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批量恢复某条监控流的推送恢复某条流的推送。
CreateStreamSnapshot触发按需截图对指定流，按需创建新的截图。
SetVsStreamsNotifyUrlConfig设置 VS 流通知 URL 配置设置推流回调配置。
DeleteVsStreamsNotifyUrlConfig删除推流回调配置删除推流回调配置。
DescribeVsStreamsNotifyUrlConfig获取 VS 流通知 URL 配置查询推流回调配置。
AddVsPullStreamInfoConfig添加拉流信息配置添加拉流配置信息。
DeleteVsPullStreamInfoConfig删除拉取流信息配置删除拉流信息。
UpdateVsPullStreamInfoConfig更新拉流信息配置更新拉流信息，修改已经添加的拉流任务中的源站地址的开始时间和结束时间。
DescribeVsPullStreamInfoConfig获取拉流信息配置查询域名下拉流配置信息。
DescribeVsStreamsOnlineList查询所有正在推的流的信息查看指定域名下（或者指定域名下某个应用）的所有正在推的流的信息。
DescribeVsStreamsPublishList获取VS流推流记录获取某一时间段内某个域名（或域名下某应用或某个流）的推流记录。

模板管理

API标题API概述
CreateTemplate创建模板创建新模板。
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时，默认读取当月的数据，同时支持按指定的起止时间查询，两者需要同时指定。 * 最多可获取90天的数据。

PTZ管理

API标题API概述
SetPreset设置预置位设置预置位。
GotoPreset移动至预置位移动至预置位。
DeletePreset删除预置位删除预置位。
DescribePresets查询预置位获取预置位列表。
StopMove停止转动镜头停止转动镜头，如水平、垂直、缩放等。
StopAdjust停止调节镜头停止调节镜头，如光圈、变焦等。
ContinuousMove持续转动镜头持续转动镜头，如水平、垂直、缩放等。
ContinuousAdjust持续调节镜头持续调节镜头，如光圈、变焦等。

目录管理

API标题API概述
CreateDirectory创建目录创建新的目录。
DeleteDirectory删除目录删除目录。
ModifyDirectory修改目录修改目录信息。
DescribeDirectory查询目录查询目录。
DescribeDirectories查询目录列表查询目录列表。
BindDirectory绑定设备到目录绑定设备至目录。
UnbindDirectory从目录里解绑设备从目录里解绑设备。
BatchBindDirectories批量绑定设备到目录批量绑定多个设备到目录。

用量查询

API标题API概述
DescribeVsDomainPvData获取域名PV数据获取域名PV数据。
DescribeVsDomainUvData获取 vs 域名 uv 数据获取 vs 域名 uv 数据 。
DescribeVsDomainPvUvData获取vs域名pv和uv数据获取vs域名pv和uv数据。
DescribeVsDomainRecordData获取 vs 域名记录数据获取 vs 域名记录数据。
DescribeVsDomainSnapshotData获取域名快照数据获取域名快照数据。
DescribeVsDomainRegionData获取域名区域数据获取域名区域数据。
DescribeVsDomainBpsData查询域名网络带宽监控数据查询域名网络带宽监控数据。
DescribeVsDomainReqBpsData获取域名网络请求监控数据获取域名网络请求监控数据。
DescribeVsDomainTrafficData获取域名流量数据获取域名流量数据。
DescribeVsDomainReqTrafficData获取 vs 域名请求流量数据获取 vs 域名请求流量数据。
DescribeVsDevicesData获取接入设备用量数据获取接入设备用量数据。
DescribeVsUpPeakPublishStreamData查询用户每日上行并发推流数峰值查询用户的每日上行并发推流数峰值。

其他

API标题API概述
VerifyVsDomainOwnerVerifyVsDomainOwner
DescribeVsVerifyContentDescribeVsVerifyContent
StartPublishStreamStartPublishStream
DescribePublishStreamStatusDescribePublishStreamStatus查询桌面采集及推流状态。
StopPublishStreamStopPublishStream
上一篇：API参考下一篇：服务接入点
文档推荐