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