API接口参考大全与功能说明-视图计算-阿里云

本产品（vs/2018-12-12）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

云应用服务管理

API	标题	API概述
实例管理	实例管理
ModifyRenderingChargeType	云应用服务实例付费方式变配	变配云渲染资源实例付费类型
CreateRenderingInstance	云应用服务实例创建	调用CreateRenderingInstance创建一个云应用服务实例
ListRenderingInstances	查询云应用服务实例基本信息列表	查询云应用服务实例基本信息列表，支持分页查询。
ModifyRenderingInstanceAttribute	修改云应用服务实例属性	修改云应用服务实例属性。
DescribeRenderingInstance	查询云应用服务实例详细信息	查询一个云应用服务实例的详细信息。
GetRenderingInstanceStreamingInfo	查询云应用服务实例流连接信息	获取一个云应用服务实例的流连接信息，每次流化建联前都需要调用此接口获取最新连接信息。
RefreshRenderingInstanceStreaming	刷新云应用服务实例流连接	调用 RefreshRenderingInstanceStreaming 刷新云应用服务实例流连接。
SendRenderingInstanceCommands	下发云应用服务实例控制指令	向一个云应用服务实例下发shell控制指令，支持同步/异步响应命令。同步场景，不适用于耗时命令（最大耗时不能超过30s）。异步场景，可通过GetRenderingInstanceCommandsStatus接口查询命令执行状态与结果。
GetRenderingInstanceCommandsStatus	查看实例控制命令执行状态	查询控制命令的执行状态，获取命令是否执行成功、执行结果字符串等。
ModifyRenderingInstance	云应用服务实例变配	变配云应用服务实例
RebootRenderingInstance	重启云应用服务实例	重启一个云应用服务实例。可通过查询接口DescribeRenderingInstance获取重启进度。
RebootRenderingServer	重启云应用服务实例所属主机	云应用服务实例主机重启
ResetRenderingInstance	重置云应用服务实例	重置一个云应用服务实例。可通过查询接口DescribeRenderingInstance获取重置进度。
ModifyRenderingInstanceBandwidth	更新云应用服务实例限速带宽	更新一个云应用服务实例的限速带宽。可以通过实例查询接口DescribeRenderingInstance，获取限速值与限速更新状态。
RenewRenderingInstance	云应用服务实例续费	调用RenewRenderingInstance续费一个云应用服务实例
ReleaseRenderingInstance	云应用服务实例释放	调用ReleaseRenderingInstance释放一个云应用服务实例
数据包管理	数据包管理
CreateRenderingDataPackage	云应用服务数据包创建	创建云应用服务数据包
ListRenderingDataPackages	查询数据包列表	查询所有云应用数据包信息，支持分页查询。
RecoverRenderingDataPackage	恢复数据到云应用服务	恢复数据到云渲染实例
ReleaseRenderingDataPackage	云应用服务数据包释放	释放云应用服务数据包
安全登录	安全登录
UploadPublicKey	上传公钥	上传一个新的公钥信息。
ListPublicKeys	查询公钥信息列表	查询满足条件的公钥信息列表，支持分页查询。
ManageLogin	云应用服务实例安全登录管理	安全登录管理。
DeletePublicKey	删除公钥	删除一个指定公钥。该公钥关联的所有云应用服务实例将自动失效登录授权。
云应用管理	云应用管理
UploadCloudApp	上传应用	上传/上架一个云应用包。属于异步接口，可通过ListCloudApps接口查询上传进度。
ListCloudApps	查询应用列表	查询云应用列表，支持分页查询。
UpdateCloudAppInfo	更新应用基本信息	更新一个云应用的信息，如更新描述信息、更新应用标签、上传Patch等。支持上传补丁包/热更包、支持安卓云应用市场制作热更包，一个云应用最多可上传20个补丁包、一个云应用同时只允许一个Patch是上传中状态。
ListCloudAppPatches	查询云应用的Patch列表	查询一个云应用的Patch列表。
InstallCloudApp	安装应用	安装一个云应用到一个指定云应用实例。属于异步接口，可通过ListCloudAppInstallations接口查询安装进度。
ListCloudAppInstallations	查询应用安装信息列表	查询云应用的安装信息列表，返回信息包括云应用服务实例的安装状态，支持分页查询。
UninstallCloudApp	卸载应用	卸载一个指定云应用实例上的一个指定云应用。属于异步接口。可通过ListCloudAppInstallations接口查询卸载进度，卸载成功后，查询接口将不再输出相关内容。
DeleteCloudApp	删除应用	删除一个云应用。使用中的云应用不允许删除。
系统配置	系统配置
DescribeRenderingInstanceConfiguration	查询云应用服务实例配置信息	查询一个云应用服务实例系统配置的实时信息。
UpdateRenderingInstanceConfiguration	更新云应用服务实例配置参数	更新一个云应用服务实例的配置参数。支持修改云安卓系统的prop/location/network 等各种配置，构建真机仿真。可通过实例查询接口DescribeRenderingInstance，获取已设置的真机仿真配置值。查询实时环境的配置参数，参考接口DescribeRenderingInstanceConfiguration。
DeleteRenderingInstanceConfiguration	删除云应用服务实例的配置设置	清除一个云应用服务实例的配置设置。仅可删除通过UpdateRenderingInstanceConfiguration接口已配置的模块属性。
DescribeRenderingInstanceSettings	查询云应用服务实例配置	调用 DescribeRenderingInstanceSettings 查询云应用服务实例配置
UpdateRenderingInstanceSettings	更新云应用服务实例设置	调用 UpdateRenderingInstanceSettings 更新云应用服务实例设置
DeleteRenderingInstanceSettings	删除云应用服务实例设置	调用 DeleteRenderingInstanceSettings 删除云应用服务实例设置
文件管理	文件管理
UploadFile	上传文件	上传一个文件。基于外链URL（公网可下载文件）实现文件上传到本地/云存储。属于异步操作，可通过ListFiles接口查询上传进度。
ListFiles	查询文件列表	查询上传的文件列表，返回内容包含文件的上传状态，支持分页查询。
UpdateFileInfo	更新文件基本信息	更新一个文件的基本信息，如描述信息。
PushFile	推送文件	推送一个文件到一个指定云应用服务实例。属于异步操作，可通过ListFilePushStatuses接口查询推送进度。
ListFilePushStatuses	查询文件推送状态信息列表	查询文件的云应用服务实例推送状态信息列表，支持分页查询。
DeleteFile	删除文件	删除一个文件对象。文件在上传/预推中时，不允许删除。文件删除后，所有相关的推送记录将失效，可重新推送同名文件。
自定义网关	自定义网关
CreateRenderingInstanceGateway	创建自定义网关	创建自定义网关。
ListRenderingInstanceGateway	查询自定义网关	查询自定义网关。
DeleteRenderingInstanceGateway	删除自定义网关	删除自定义网关。
项目管理	项目管理
CreateRenderingProject	创建项目	创建一个新的云应用服务项目，并设置会话等相关属性。
ListRenderingProjects	查询项目列表	分页查询用户下的云应用服务项目基本信息列表。
UpdateRenderingProject	更新项目信息	更新一个项目的属性信息
AssociateRenderingProjectInstances	项目增加实例关联	云应用服务实例与项目进行关联。
ListRenderingProjectInstances	查询项目的实例关联信息	分页查询项目关联的云应用服务实例信息列表。
GetRenderingProjectInstanceStateMetrics	查询项目实例状态统计信息	查询一个项目满足特定条件的项目实例各状态数据量统计值。
DisassociateRenderingProjectInstances	项目解除实例关联	云应用服务实例与项目解除关联关系。
DeleteRenderingProject	删除项目	删除一个云应用服务项目，有在线会话等业务调度数据的项目不允许删除。
会话管理	会话管理
StartRenderingSession	启动会话	为请求端（ClientId）调度一个空闲云应用服务实例，并完成服务启动。如果请求端（ClientId）启动请求发起成功后重复发起启动请求，若已关联会话处于启动暂停（SessionStartSuspended）状态，则重启会话；若会话为其他状态，则直接返回会话信息。
ListRenderingSessions	查询会话列表	分页查询指定条件下的云应用服务会话列表。
DescribeRenderingSession	查询会话信息	查询会话的详情信息，包含会话当前状态、网络访问IP/端口、云应用服务实例位置等信息。
StopRenderingSession	关闭会话	关闭指定的云应用服务会话并回收相关实例资源。

账户

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	查询用户每日上行并发推流数峰值	查询用户的每日上行并发推流数峰值。