API概览

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

账户

API标题API概述
DescribeAccountStat获取帐户状态获取帐户状态。
OpenVsService开通服务开通服务。

空间管理

API标题API概述
CreateGroup创建业务空间创建新业务空间。
ModifyGroup修改业务空间修改空间信息。
DescribeGroup获取空间信息获取空间信息。
DescribeGroups查询空间列表查询空间列表。

设备管理

API标题API概述
CreateDevice添加设备添加新的设备。
CreateDeviceAlarm创建设备警报上报设备告警。
ModifyDevice修改设备修改设备信息。
ModifyDeviceAlarm修改设备报警更新设备告警状态。
ModifyDeviceCapture修改设备捕获修改设备图传配置。
ModifyDeviceChannels修改设备通道更新设备通道列表。
StopDevice停止设备停止设备拉流,会停止设备上的所有流。
DescribeDevice查询设备查询设备信息。
DescribeDeviceGateway查询设备网关查询设备网关。
DescribeDevices查询设备列表查询设备列表。
DescribeDeviceURL查询设备URL查询设备流的URL信息。
DescribePurchasedDevice查询已购买设备查询已购买设备信息。
DescribePurchasedDevices查询已购买设备列表查询已购买设备列表。
BatchBindParentPlatformDevices批量绑定父平台设备批量绑定多个设备到上级平台推送。
BatchBindPurchasedDevices批量绑定购买设备批量绑定购买设备。
BatchStopDevices批量停止设备批量停止设备拉流。
BatchUnbindParentPlatformDevices批量解除父平台设备绑定从上级平台推送中批量解绑多个设备。
BatchUnbindPurchasedDevices批量解绑已购买设备从空间批量解绑多个已购设备。
BindParentPlatformDevice绑定父平台设备绑定设备到上级平台推送。
BindPurchasedDevice绑定已购买设备绑定已购买设备至空间。
UnbindParentPlatformDevice解除父平台绑定的设备从上级平台推送中解绑设备,不再推送。
UnbindPurchasedDevice解绑已购买设备从空间解绑已购买设备。

流管理

API标题API概述
AddVsPullStreamInfoConfig添加拉流信息配置添加拉流配置信息。
CreateStreamSnapshot触发按需截图对指定流,按需创建新的截图。
DeleteVsPullStreamInfoConfig删除拉取流信息配置删除拉流信息。
DeleteVsStreamsNotifyUrlConfig删除推流回调配置删除推流回调配置。
SetVsStreamsNotifyUrlConfig设置vs流通知url配置设置推流回调配置。
StartStream启动流启动流。
StartTransferStream启动传输流启动转推流到外部的地址。
StopStream停止流停止流。
StopTransferStream停止传输流停止流。
UpdateVsPullStreamInfoConfig更新拉流信息配置更新拉流信息, 修改已经添加的拉流任务中的源站地址, 开始时间和结束时间。
DescribeStream查询流详情查询流信息。
DescribeStreams查询流列表查询流的列表信息,支持通过流的Id,名称,空间Id,设备Id等过滤筛选。
DescribeStreamURL获取流URL获取流URL信息。
DescribeStreamVodList获取流视频点播列表获取流点播记录列表,例如来自NVR的历史流列表。
DescribeVodStreamURL获取vod流url获取点播流的URL信息。
DescribeVsPullStreamInfoConfig获取拉流信息配置查询域名下拉流配置信息。
DescribeVsStreamsNotifyUrlConfig获取 VS 流通知 URL 配置查询推流回调配置。
DescribeVsStreamsOnlineList查询所有正在推的流的信息查看指定域名下(或者指定域名下某个应用)的所有正在推的流的信息。
DescribeVsUpPeakPublishStreamData查询用户每日上行并发推流数峰值查询用户的每日上行并发推流数峰值。
BatchForbidVsStream批量禁止vs流禁止某条流的推送,可以预设某个时刻将流恢复。
BatchResumeVsStream批量恢复某条监控流的推送恢复某条流的推送。
ForbidVsStream禁止某条流的推送禁止某条流的推送,可以预设某个时刻将流恢复。
ResumeVsStream恢复某条流的推送恢复某条流的推送。

模板管理

API标题API概述
CreateTemplate创建模板创建新模板。
ModifyTemplate修改模板修改模板信息。
DescribeTemplate查询模板查询模板信息。
DescribeTemplates查询模板列表查询模板列表。
BatchBindTemplates批量绑定模板批量绑定模板。
BatchUnbindTemplates批量解除绑定模板批量解除绑定模板。

录制管理

API标题API概述
DescribeRecords查询录制记录列表查询录制记录列表。
StopRecordStream停止按需录制对指定流停止按需录制。
StartRecordStream启动按需录制对指定流启动按需录制。

域名管理

API标题API概述
SetVsDomainCertificate设置域名证书信息设置某域名下证书功能是否启用。
DescribeVsDomainPvData获取域名PV数据获取域名PV数据。
DescribeVsDomainPvUvData获取vs域名pv和uv数据获取vs域名pv和uv数据。
DescribeVsDomainRecordData获取 vs 域名记录数据获取 vs 域名记录数据。
DescribeVsDomainRegionData获取域名域区域数据获取域名域区域数据。
DescribeVsDomainReqBpsData获取域名网络请求监控数据获取域名网络请求监控数据。
DescribeVsDomainReqTrafficData获取 vs 域名请求流量数据获取 vs 域名请求流量数据。
DescribeVsDomainSnapshotData获取域名快照数据获取域名快照数据。
DescribeVsDomainTrafficData获取域名流量数据获取域名流量数据。
DescribeVsDomainUvData获取 vs 域名 uv 数据获取 vs 域名 uv 数据 。
DescribeVsStreamsPublishList获取vs流推流记录获取某一时间段内某个域名(或域名下某应用或某个流)的推流记录。
DescribeVsTopDomainsByFlow获取顶级域名获取用户按流量排名的域名 不指定StartTime和EndTime时,默认读取当月的数据,同时支持按指定的起止时间查询,两者需要同时指定。 * 最多可获取90天的数据。
DescribeVsCertificateDetail获取证书详情获取证书详细信息。
DescribeVsCertificateList获取证书列表获取域名证书列表信息。
DescribeVsDomainBpsData查询域名网络带宽监控数据查询域名网络带宽监控数据。
DescribeVsDomainCertificateInfo获取指定加速域名证书信息获取指定加速域名证书信息。
DescribeVsDomainConfigs查询域名配置查询域名配置,一次可查询多个功能配置。
DescribeVsDomainDetail查询域名信息获取指定视图计算域名配置的基本信息。
BatchSetVsDomainConfigs批量配置域名域名批量配置。

PTZ管理

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

目录管理

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

级联平台管理

API标题API概述
CreateParentPlatform添加上级平台添加新的上级平台。
DeleteParentPlatform删除上级平台删除上级平台。
ModifyParentPlatform修改上级平台修改上级平台信息。
StartParentPlatform启动上级平台交互启动上级平台交互,如注册、保活等。
DescribeParentPlatform查询上级平台查询上级平台信息。
DescribeParentPlatformDevices查询上级平台下的设备列表查询上级平台下的设备列表。
DescribeParentPlatforms查询上级平台列表查询上级平台列表。

用量查询

API标题API概述
DescribeVsDevicesData获取接入设备用量数据获取接入设备用量数据。
DescribeVsStorageTrafficUsageData获取视图存储流量用量数据获取视图存储流量用量数据。
DescribeVsStorageUsageData获取视图存储用量数据获取视图存储用量数据。
阿里云首页 视图计算 相关技术圈