public class LiveTrait extends BaseServiceImpl
限定符和类型 | 类和说明 |
---|---|
static class |
LiveTrait.ResponseModel |
apiInfoList, credentials, ISigner, serviceInfo
限定符 | 构造器和说明 |
---|---|
protected |
LiveTrait() |
protected |
LiveTrait(ServiceInfo serviceInfo) |
destroy, getAccessKey, getApiInfoList, getHttpClient, getISigner, getRegion, getSecretKey, getServiceInfo, getSessionToken, getSignUrl, json, post, postFileMultiPart, prepareRequest, proto, put, putData, putData, putDataWithResponse, putDataWithResponse, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSessionToken, setSocketTimeout, signSts2
protected LiveTrait()
protected LiveTrait(ServiceInfo serviceInfo)
public DeleteTranscodePresetRes deleteTranscodePreset(DeleteTranscodePresetBody body) throws Exception
deleteTranscodePreset
删除转码配置
依据模版名称、域名名称和 `App` 信息,删除指定模板。首先解除 `App` 和模版之间的绑定,再判断若没有其它 `App` 绑定该模版,则安全删除该模版。
body
- body payloadException
- error during requestpublic UpdateTranscodePresetRes updateTranscodePreset(UpdateTranscodePresetBody body) throws Exception
updateTranscodePreset
更新转码配置
更新转码模版相关配置,若未填写非必选参数,则转码模板配置不发生改变。
body
- body payloadException
- error during requestpublic ListCommonTransPresetDetailRes listCommonTransPresetDetail(ListCommonTransPresetDetailBody body) throws Exception
listCommonTransPresetDetail
查询内置转码档位的详细配置
调用该接口查询直播系统内置转码档位的详细配置。
body
- body payloadException
- error during requestpublic ListVhostTransCodePresetRes listVhostTransCodePreset(ListVhostTransCodePresetBody body) throws Exception
listVhostTransCodePreset
查询转码配置列表
查询指定域名空间下的全部应用以及与其相关联的转码配置。
body
- body payloadException
- error during requestpublic CreateTranscodePresetRes createTranscodePreset(CreateTranscodePresetBody body) throws Exception
createTranscodePreset
添加转码配置
调用接口添加转码模版。新增转码模版会先加入模版库,再绑定到对应的 `App`。
body
- body payloadException
- error during requestpublic DeleteWatermarkPresetRes deleteWatermarkPreset(DeleteWatermarkPresetBody body) throws Exception
deleteWatermarkPreset
删除水印
删除指定 App 的水印。
body
- body payloadException
- error during requestpublic UpdateWatermarkPresetRes updateWatermarkPreset(UpdateWatermarkPresetBody body) throws Exception
updateWatermarkPreset
更新水印
修改指定 App 的水印。支持修改水印图片、位置、尺寸等参数。
body
- body payloadException
- error during requestpublic ListWatermarkPresetRes listWatermarkPreset(ListWatermarkPresetBody body) throws Exception
listWatermarkPreset
查询水印
查询指定 App 的水印信息。
body
- body payloadException
- error during requestpublic ListVhostWatermarkPresetRes listVhostWatermarkPreset(ListVhostWatermarkPresetBody body) throws Exception
listVhostWatermarkPreset
查询水印列表
查询视频直播配置空间 `Vhost` 下的水印列表。
body
- body payloadException
- error during requestpublic CreateWatermarkPresetRes createWatermarkPreset(CreateWatermarkPresetBody body) throws Exception
createWatermarkPreset
添加水印
为指定的 App 添加水印。支持设置水印图片、位置、尺寸等参数。
body
- body payloadException
- error during requestpublic StopPullRecordTaskRes stopPullRecordTask(StopPullRecordTaskBody body) throws Exception
stopPullRecordTask
停止直播录制任务
创建直播录制任务成功后,使用该接口停止任务。
body
- body payloadException
- error during requestpublic CreatePullRecordTaskRes createPullRecordTask(CreatePullRecordTaskBody body) throws Exception
createPullRecordTask
创建直播录制任务
本接口支持创建直播录制任务,创建成功后,可以将实时的视频直播流进行录制(Record)并保存为视频文件。
body
- body payloadException
- error during requestpublic DeleteRecordPresetRes deleteRecordPreset(DeleteRecordPresetBody body) throws Exception
deleteRecordPreset
删除录制配置
调用接口删除录制配置模版。调用后,首先解除 `App` 和模版之间的绑定,其次判断如果没有其它 `App` 绑定该模版,则会安全删除该录制配置模版。
:::tip
删除录制配置不会同步删除相关回调配置。
:::
body
- body payloadException
- error during requestpublic UpdateRecordPresetV2Res updateRecordPresetV2(UpdateRecordPresetV2Body body) throws Exception
updateRecordPresetV2
更新录制配置
根据域名空间下的应用所关联的录制模版配置更新修改,可调整格式和存储目录等。
:::tip
如果请求时,未传入非必选参数,则不更改该参数值。
:::
body
- body payloadException
- error during requestpublic DescribeRecordTaskFileHistoryRes describeRecordTaskFileHistory(DescribeRecordTaskFileHistoryBody body) throws Exception
describeRecordTaskFileHistory
查询录制历史详情
调用接口查询指定 `Vhost` 下的直播录制历史信息。包括但不限于录制时长、文件格式、开始时间、结束时间。
body
- body payloadException
- error during requestpublic ListVhostRecordPresetV2Res listVhostRecordPresetV2(ListVhostRecordPresetV2Body body) throws Exception
listVhostRecordPresetV2
查询录制配置列表
根据域名下所有的应用名称,查询与各应用关联的录制模板。
body
- body payloadException
- error during requestpublic ListPullRecordTaskRes listPullRecordTask(ListPullRecordTaskBody body) throws Exception
listPullRecordTask
查询直播录制任务
获取当前账号下,已经创建的直播录制任务列表。
body
- body payloadException
- error during requestpublic CreateRecordPresetV2Res createRecordPresetV2(CreateRecordPresetV2Body body) throws Exception
createRecordPresetV2
添加录制配置
为指定域名空间下的 App 添加录制模版。
:::tip
暂不支持对同一个域名下的同一个 App 绑定多个录制模板,如果多次创建录制模板,会将历史创建的录制模板删除,重新创建新的模板并绑定。
:::
body
- body payloadException
- error during requestpublic DeleteSnapshotPresetRes deleteSnapshotPreset(DeleteSnapshotPresetBody body) throws Exception
deleteSnapshotPreset
删除截图配置
调用接口删除截图模版配置。调用后,根据模版名称、域名和应用名称信息,先解除应用和模版之间的绑定;其次判断如果没有其它应用绑定这个模版,则安全删除这个模版。
:::tip
删除截图配置不会同步删除相关回调配置。
:::
body
- body payloadException
- error during requestpublic UpdateSnapshotPresetRes updateSnapshotPreset(UpdateSnapshotPresetBody body) throws Exception
updateSnapshotPreset
更新截图配置
查询域名和应用关联的直播截图模版,并更新某截图模版的配置项。
:::tip
调用 [UpdateCallback](https://www.volcengine.com/docs/6469/1126929) 和 [UpdateSnapshotPreset](https://www.volcengine.com/docs/6469/1126863) API,都可以更新截图回调配置,当重复调用以上两个接口更新截图回调配置时,**以最后一次调用的配置为准**。例如,您先调用 UpdateCallback 为某域名空间下的 App 配置了回调地址`https://live.example.com/callback`,之后调用 UpdateSnapshotPreset 再次对该域名空间下的同一 App 配置了回调地址 `https://live.example.com/callback1`,则最终生效的回调地址为 `https://live.example.com/callback1`。
:::
body
- body payloadException
- error during requestpublic DescribeCDNSnapshotHistoryRes describeCDNSnapshotHistory(DescribeCDNSnapshotHistoryBody body) throws Exception
describeCDNSnapshotHistory
查询截图历史详情
调用接口查询指定 `Vhost` 下的直播截图历史详情。
body
- body payloadException
- error during requestpublic ListVhostSnapshotPresetRes listVhostSnapshotPreset(ListVhostSnapshotPresetBody body) throws Exception
listVhostSnapshotPreset
查询截图配置列表
查询域名维度下所有的 App 名称,以及 App 关联的截图模板。
body
- body payloadException
- error during requestpublic CreateSnapshotPresetRes createSnapshotPreset(CreateSnapshotPresetBody body) throws Exception
createSnapshotPreset
添加截图配置
调用接口添加视频直播截图配置。调用后会先增加截图模版,将新建模版加入模版库中,再将该模版绑定到对应的 App 上。
:::tip
调用 [UpdateCallback](https://www.volcengine.com/docs/6469/1126929) 和 [CreateSnapshotPreset](https://www.volcengine.com/docs/6469/1126861) API,都可以更新截图回调配置,当重复调用以上两个接口更新截图回调配置时,**以最后一次调用的配置为准**。例如,您先调用 UpdateCallback 为某域名空间下的 App 配置了回调地址`https://live.example.com/callback`,之后调用 CreateSnapshotPreset 再次对该域名空间下的同一 App 配置了回调地址 `https://live.example.com/callback1`,则最终生效的回调地址为 `https://live.example.com/callback1`。
:::
body
- body payloadException
- error during requestpublic DeleteTimeShiftPresetV3Res deleteTimeShiftPresetV3(DeleteTimeShiftPresetV3Body body) throws Exception
deleteTimeShiftPresetV3
删除直播时移配置
调用接口删除指定应用的直播时移模板。
body
- body payloadException
- error during requestpublic UpdateTimeShiftPresetV3Res updateTimeShiftPresetV3(UpdateTimeShiftPresetV3Body body) throws Exception
updateTimeShiftPresetV3
更新直播时移配置
修改指定域名空间和 `APP` 的直播时移配置,包括时移时长、配置状态等信息。
body
- body payloadException
- error during requestpublic ListTimeShiftPresetV2Res listTimeShiftPresetV2(ListTimeShiftPresetV2Body body) throws Exception
listTimeShiftPresetV2
查询直播时移配置列表
根据域名查询指定应用绑定的时移模板列表。
body
- body payloadException
- error during requestpublic CreateTimeShiftPresetV3Res createTimeShiftPresetV3(CreateTimeShiftPresetV3Body body) throws Exception
createTimeShiftPresetV3
添加直播时移配置
调用 CreateTimeShiftPresetV3 接口,新增直播时移配置。
body
- body payloadException
- error during requestpublic DeleteCallbackRes deleteCallback(DeleteCallbackBody body) throws Exception
deleteCallback
删除回调配置
删除指定的 `Vhost` 和 `APP` 下的某个指定类型的回调配置。
body
- body payloadException
- error during requestpublic DescribeCallbackRes describeCallback(DescribeCallbackBody body) throws Exception
describeCallback
查询回调配置
根据 `Domain` 和 `App` 类型信息,查询对应的回调信息。
body
- body payloadException
- error during requestpublic UpdateCallbackRes updateCallback(UpdateCallbackBody body) throws Exception
updateCallback
添加或更新回调配置
添加或更新直播推流、直播断流、录制和截图的回调。在更新场景下,调用成功后,会对所有的回调内容做全量更新。
body
- body payloadException
- error during requestpublic DescribeAuthRes describeAuth(DescribeAuthBody body) throws Exception
describeAuth
查询推拉流鉴权
调用接口查询推拉流鉴权信息。
body
- body payloadException
- error during requestpublic DeleteCertRes deleteCert(DeleteCertBody body) throws Exception
deleteCert
删除证书
删除一个已经上传的证书。
body
- body payloadException
- error during requestpublic DescribeCertDetailSecretV2Res describeCertDetailSecretV2(DescribeCertDetailSecretV2Body body) throws Exception
describeCertDetailSecretV2
查看证书详情
查询证书详情V2
body
- body payloadException
- error during requestpublic ListCertV2Res listCertV2(ListCertV2Body body) throws Exception
listCertV2
查询证书列表
查看当前账号下的证书列表。
body
- body payloadException
- error during requestpublic CreateCertRes createCert(CreateCertBody body) throws Exception
createCert
添加证书
调用该接口上传证书,需要填写证书名称和证书内容等参数。
body
- body payloadException
- error during requestpublic BindCertRes bindCert(BindCertBody body) throws Exception
bindCert
绑定证书
调用接口绑定域名与证书。
body
- body payloadException
- error during requestpublic UnbindCertRes unbindCert(UnbindCertBody body) throws Exception
unbindCert
解绑证书
解除域名和证书之间的绑定关系。
body
- body payloadException
- error during requestpublic CreateVerifyContentRes createVerifyContent(CreateVerifyContentBody body) throws Exception
createVerifyContent
查询校验归属权内容
调用CreateVerifyContent查询归属校验内容。
body
- body payloadException
- error during requestpublic VerifyDomainOwnerRes verifyDomainOwner(VerifyDomainOwnerBody body) throws Exception
verifyDomainOwner
校验域名归属权
调用VerifyDomainOwner对域名归属权进行校验。
body
- body payloadException
- error during requestpublic DeleteDomainRes deleteDomain(DeleteDomainBody body) throws Exception
deleteDomain
删除域名
删除已添加的推/拉流域名。
body
- body payloadException
- error during requestpublic EnableDomainRes enableDomain(EnableDomainBody body) throws Exception
enableDomain
启用域名
启用某个直播域名。启用后,域名状态从`2-禁用状态`变为`0-正常状态`。
body
- body payloadException
- error during requestpublic CreateDomainV2Res createDomainV2(CreateDomainV2Body body) throws Exception
createDomainV2
批量添加域名
批量添加域名。域名请在工信部完成备案。新添加的域名的状态为**审核中**。
body
- body payloadException
- error during requestpublic UpdateDomainVhostRes updateDomainVhost(UpdateDomainVhostBody body) throws Exception
updateDomainVhost
更新域名的域名空间
切换推流域名或拉流域名的域名空间。
body
- body payloadException
- error during requestpublic DescribeDomainRes describeDomain(DescribeDomainBody body) throws Exception
describeDomain
查询域名信息
查询域名的详细信息,包括但不限于域名空间、CName、类型、域名状态。
body
- body payloadException
- error during requestpublic ListDomainDetailRes listDomainDetail(ListDomainDetailBody body) throws Exception
listDomainDetail
查询域名列表
调用 ListDomainDetail 接口,根据域名状态、类别等信息,过滤查询当前账号下的的域名列表信息。
body
- body payloadException
- error during requestpublic CreateDomainRes createDomain(CreateDomainBody body) throws Exception
createDomain
添加域名
添加推拉流域名。
一次只能提交一个域名。域名请在工信部完成备案。新添加域名的状态默认为**审核中**。
body
- body payloadException
- error during requestpublic DisableDomainRes disableDomain(DisableDomainBody body) throws Exception
disableDomain
禁用域名
禁用某个直播域名。禁用后,域名状态从`0-正常状态`变为`2-禁用状态`。
body
- body payloadException
- error during requestpublic StopPullToPushTaskRes stopPullToPushTask(StopPullToPushTaskBody body) throws Exception
stopPullToPushTask
停用拉流转推任务
创建拉流转推任务成功后,使用该接口停用任务。
body
- body payloadException
- error during requestpublic CreatePullToPushTaskRes createPullToPushTask(CreatePullToPushTaskBody body) throws Exception
createPullToPushTask
创建拉流转推任务
创建一个拉流转推任务,支持从点播拉流与从直播拉流两种方式。
body
- body payloadException
- error during requestpublic DeletePullToPushTaskRes deletePullToPushTask(DeletePullToPushTaskBody body) throws Exception
deletePullToPushTask
删除拉流转推任务
创建拉流转推任务成功后,使用该接口删除任务。
body
- body payloadException
- error during requestpublic RestartPullToPushTaskRes restartPullToPushTask(RestartPullToPushTaskBody body) throws Exception
restartPullToPushTask
启用拉流转推任务
创建拉流转推任务成功后,使用该接口启用任务。
body
- body payloadException
- error during requestpublic UpdatePullToPushTaskRes updatePullToPushTask(UpdatePullToPushTaskBody body) throws Exception
updatePullToPushTask
更新拉流转推任务
创建拉流转推任务成功后,使用该接口修改任务参数。
body
- body payloadException
- error during requestpublic ListPullToPushTaskRes listPullToPushTask(ListPullToPushTaskQuery query) throws Exception
listPullToPushTask
获取拉流转推任务列表
获取当前账号下,已经创建的拉流转推任务列表。
query
- query argumentsException
- error during requestpublic DeleteRelaySourceV4Res deleteRelaySourceV4(DeleteRelaySourceV4Body body) throws Exception
deleteRelaySourceV4
删除固定回源配置
本接口支持删除域名空间下指定的固定回源(含永久回源)配置。
body
- body payloadException
- error during requestpublic DeleteRelaySourceV3Res deleteRelaySourceV3(DeleteRelaySourceV3Body body) throws Exception
deleteRelaySourceV3
删除播放触发回源配置
删除指定范围内的拉流回源配置。
body
- body payloadException
- error during requestpublic UpdateRelaySourceV4Res updateRelaySourceV4(UpdateRelaySourceV4Body body) throws Exception
updateRelaySourceV4
更新固定回源配置
本接口支持更新域名空间下指定的固定回源(含永久回源)配置。
body
- body payloadException
- error during requestpublic ListRelaySourceV4Res listRelaySourceV4(ListRelaySourceV4Body body) throws Exception
listRelaySourceV4
查询固定回源配置列表
本接口支持查询域名空间的固定回源(含永久回源)配置列表。
body
- body payloadException
- error during requestpublic DescribeRelaySourceV3Res describeRelaySourceV3(DescribeRelaySourceV3Body body) throws Exception
describeRelaySourceV3
查询播放触发回源配置
本接口支持根据 `Vhost` 信息,查询对应的播放触发的拉流回源配置信息。
body
- body payloadException
- error during requestpublic CreateRelaySourceV4Res createRelaySourceV4(CreateRelaySourceV4Body body) throws Exception
createRelaySourceV4
添加固定回源配置
本接口支持对域名空间下指定的 App 和 Stream 添加固定回源(含永久回源)配置。
body
- body payloadException
- error during requestpublic UpdateRelaySourceV3Res updateRelaySourceV3(UpdateRelaySourceV3Body body) throws Exception
updateRelaySourceV3
添加或更新播放触发回源配置
添加回源配置。本接口支持在指定应用名称后,选择相应的回源协议和回源地址,添加新的拉流回源配置。
body
- body payloadException
- error during requestpublic KillStreamRes killStream(KillStreamBody body) throws Exception
killStream
断开直播流
调用接口断开指定的在线流。
body
- body payloadException
- error during requestpublic DescribeClosedStreamInfoByPageRes describeClosedStreamInfoByPage(DescribeClosedStreamInfoByPageQuery query) throws Exception
describeClosedStreamInfoByPage
查询历史流列表
调用接口分页查询历史流信息。
query
- query argumentsException
- error during requestpublic DescribeLiveStreamInfoByPageRes describeLiveStreamInfoByPage(DescribeLiveStreamInfoByPageQuery query) throws Exception
describeLiveStreamInfoByPage
查询在线流列表
调用接口分页查询在线流列表信息。
query
- query argumentsException
- error during requestpublic DescribeLiveStreamStateRes describeLiveStreamState(DescribeLiveStreamStateQuery query) throws Exception
describeLiveStreamState
查询流状态
调用接口查询指定流的当前推流状态。
query
- query argumentsException
- error during requestpublic DescribeForbiddenStreamInfoByPageRes describeForbiddenStreamInfoByPage(DescribeForbiddenStreamInfoByPageQuery query) throws Exception
describeForbiddenStreamInfoByPage
查询禁推流列表
调用接口分页查询禁止直播推流的流列表。
query
- query argumentsException
- error during requestpublic ForbidStreamRes forbidStream(ForbidStreamBody body) throws Exception
forbidStream
禁推直播流
调用接口禁止指定在线流的推流。
body
- body payloadException
- error during requestpublic ResumeStreamRes resumeStream(ResumeStreamBody body) throws Exception
resumeStream
解禁直播流
调用接口指定某个被禁推的直播流,恢复该直播流的推流。
body
- body payloadException
- error during requestpublic GeneratePlayURLRes generatePlayURL(GeneratePlayURLBody body) throws Exception
generatePlayURL
生成拉流地址
调用接口生成拉流地址。
body
- body payloadException
- error during requestpublic GeneratePushURLRes generatePushURL(GeneratePushURLBody body) throws Exception
generatePushURL
生成推流地址
调用接口生成推流地址。
body
- body payloadException
- error during requestpublic DeleteStreamQuotaConfigRes deleteStreamQuotaConfig(DeleteStreamQuotaConfigBody body) throws Exception
deleteStreamQuotaConfig
删除推拉流限额配置
删除指定推/拉流域名的限额配置。
body
- body payloadException
- error during requestpublic DescribeStreamQuotaConfigRes describeStreamQuotaConfig(DescribeStreamQuotaConfigBody body) throws Exception
describeStreamQuotaConfig
查询推拉流限流配置
查询指定推/拉流域名的限额配置。
body
- body payloadException
- error during requestpublic UpdateStreamQuotaConfigRes updateStreamQuotaConfig(UpdateStreamQuotaConfigBody body) throws Exception
updateStreamQuotaConfig
添加或更新推拉流限额配置
添加或更新推拉流限额配置。更新时,会对所有的限额参数做**全量覆盖更新**。
body
- body payloadException
- error during requestpublic ListVqosMetricsDimensionsRes listVqosMetricsDimensions(ListVqosMetricsDimensionsQuery query) throws Exception
listVqosMetricsDimensions
获取图表指标维度信息
获取图表指标维度信息
query
- query argumentsException
- error during requestpublic StopPullCDNSnapshotTaskRes stopPullCDNSnapshotTask(StopPullCDNSnapshotTaskBody body) throws Exception
stopPullCDNSnapshotTask
停止直播截图任务
调用 StopPullCDNSnapshotTask 接口,停止拉流截图任务。
body
- body payloadException
- error during requestpublic CreatePullCDNSnapshotTaskRes createPullCDNSnapshotTask(CreatePullCDNSnapshotTaskBody body) throws Exception
createPullCDNSnapshotTask
创建直播截图任务
调用 CreatePullCDNSnapshotTask 接口,创建直播截图任务。
body
- body payloadException
- error during requestpublic GetPullCDNSnapshotTaskRes getPullCDNSnapshotTask(GetPullCDNSnapshotTaskBody body) throws Exception
getPullCDNSnapshotTask
查询单个直播截图任务
调用 GetPullCDNSnapshotTask 接口,查询单个直播截图任务的信息。
body
- body payloadException
- error during requestpublic ListPullCDNSnapshotTaskRes listPullCDNSnapshotTask(ListPullCDNSnapshotTaskBody body) throws Exception
listPullCDNSnapshotTask
查询所有直播截图任务
调用 ListPullCDNSnapshotTask 接口,查询所有直播截图任务。
body
- body payloadException
- error during requestpublic GetPullRecordTaskRes getPullRecordTask(GetPullRecordTaskBody body) throws Exception
getPullRecordTask
查询单个直播录制任务
调用 GetPullRecordTask 接口,查询单个直播录制任务信息。
body
- body payloadException
- error during requestpublic DeleteSnapshotAuditPresetRes deleteSnapshotAuditPreset(DeleteSnapshotAuditPresetBody body) throws Exception
deleteSnapshotAuditPreset
删除截图审核配置
删除截图审核配置。
:::tip
删除截图审核配置不会同步删除相关回调配置。
:::
body
- body payloadException
- error during requestpublic UpdateSnapshotAuditPresetRes updateSnapshotAuditPreset(UpdateSnapshotAuditPresetBody body) throws Exception
updateSnapshotAuditPreset
更新截图审核配置
修改截图审核配置。
:::tip
调用 [UpdateCallback](https://www.volcengine.com/docs/6469/1126929) 和 [UpdateSnapshotAuditPreset](https://www.volcengine.com/docs/6469/1126869) API,都可以更新截图审核回调配置,当重复调用以上两个接口更新截图审核回调配置时,**以最后一次调用的配置为准**。例如,您先调用 UpdateCallback 为某域名空间下的 App 配置了回调地址`https://live.example.com/callback`,之后调用 UpdateSnapshotAuditPreset 再次对该域名空间下的同一 App 配置了回调地址 `https://live.example.com/callback1`,则最终生效的回调地址为 `https://live.example.com/callback1`。
:::
body
- body payloadException
- error during requestpublic DescribeSnapshotAuditPresetDetailRes describeSnapshotAuditPresetDetail(DescribeSnapshotAuditPresetDetailBody body) throws Exception
describeSnapshotAuditPresetDetail
查询截图审核模板详情
查询截图审核模板详情
body
- body payloadException
- error during requestpublic ListVhostSnapshotAuditPresetRes listVhostSnapshotAuditPreset(ListVhostSnapshotAuditPresetBody body) throws Exception
listVhostSnapshotAuditPreset
查询截图审核配置列表
查询截图审核配置。
body
- body payloadException
- error during requestpublic CreateSnapshotAuditPresetRes createSnapshotAuditPreset(CreateSnapshotAuditPresetBody body) throws Exception
createSnapshotAuditPreset
添加截图审核配置
添加截图审核配置。
:::tip
调用 [UpdateCallback](https://www.volcengine.com/docs/6469/1126929) 和 [CreateSnapshotAuditPreset](https://www.volcengine.com/docs/6469/1126867) API,都可以更新截图审核回调配置,当重复调用以上两个接口更新截图审核回调配置时,**以最后一次调用的配置为准**。例如,您先调用 UpdateCallback 为某域名空间下的 App 配置了回调地址`https://live.example.com/callback`,之后调用 CreateSnapshotAuditPreset 再次对该域名空间下的同一 App 配置了回调地址 `https://live.example.com/callback1`,则最终生效的回调地址为 `https://live.example.com/callback1`。
:::
body
- body payloadException
- error during requestpublic DescribeIpInfoRes describeIpInfo(DescribeIpInfoBody body) throws Exception
describeIpInfo
查询 IP 地址归属的 CDN 节点
本接口用于查询指定 IP 地址是否属于火山引擎 CDN 节点。
body
- body payloadException
- error during requestpublic DescribeLiveRegionDataRes describeLiveRegionData() throws Exception
describeLiveRegionData
查询区域标识符
查询用户所在的区域标识符。
Exception
- error during requestpublic DescribeLiveSourceStreamMetricsRes describeLiveSourceStreamMetrics(DescribeLiveSourceStreamMetricsBody body) throws Exception
describeLiveSourceStreamMetrics
查询单路回源流监控数据
支持查询一定时间范围内单路直播回源流的音视频帧率、码率等信息,用于判断回源流的健康程度。
body
- body payloadException
- error during requestpublic DescribeLivePushStreamMetricsRes describeLivePushStreamMetrics(DescribeLivePushStreamMetricsBody body) throws Exception
describeLivePushStreamMetrics
查询单路推流监控数据
支持查询一定时间范围内单路直播推流的音视频帧率、码率等信息,用于判断直播推流的健康程度。支持查询删除域名的直播推流数据。
body
- body payloadException
- error during requestpublic DescribeLivePlayStatusCodeDataRes describeLivePlayStatusCodeData(DescribeLivePlayStatusCodeDataBody body) throws Exception
describeLivePlayStatusCodeData
查询域名状态码占比
查询一定时间范围内直播拉流请求的状态码占比数据,支持按地区和运营商区分。支持查询删除域名的状态码数据。
body
- body payloadException
- error during requestpublic DescribeLiveBatchSourceStreamMetricsRes describeLiveBatchSourceStreamMetrics(DescribeLiveBatchSourceStreamMetricsBody body) throws Exception
describeLiveBatchSourceStreamMetrics
查询多路回源流监控数据
支持查询一定时间范围内多路直播回源流的音视频帧率、码率等信息,用于判断回源流的健康程度。
body
- body payloadException
- error during requestpublic DescribeLiveBatchPushStreamMetricsRes describeLiveBatchPushStreamMetrics(DescribeLiveBatchPushStreamMetricsBody body) throws Exception
describeLiveBatchPushStreamMetrics
查询多路推流监控数据
支持查询一定时间范围内指定推流域名下直播推流的音视频帧率、码率等信息,用于判断直播推流的健康程度。支持查询删除域名的直播推流数据。
body
- body payloadException
- error during requestpublic DescribeLiveStreamCountDataRes describeLiveStreamCountData(DescribeLiveStreamCountDataBody body) throws Exception
describeLiveStreamCountData
查询峰值流数
查询推流、拉流、回源流、转码流的峰值流数。
body
- body payloadException
- error during requestpublic DescribeLivePushStreamCountDataRes describeLivePushStreamCountData(DescribeLivePushStreamCountDataBody body) throws Exception
describeLivePushStreamCountData
查询推流峰值流数
查询推流峰值流数数据。
body
- body payloadException
- error during requestpublic DescribeLiveSourceBandwidthDataRes describeLiveSourceBandwidthData(DescribeLiveSourceBandwidthDataBody body) throws Exception
describeLiveSourceBandwidthData
查询直播流或域名的回源带宽监控数据
查询一定时间范围内直播拉流或域名的回源带宽监控数据。
body
- body payloadException
- error during requestpublic DescribeLiveSourceTrafficDataRes describeLiveSourceTrafficData(DescribeLiveSourceTrafficDataBody body) throws Exception
describeLiveSourceTrafficData
查询直播流或域名的回源流量监控数据
查询一定时间范围内直播拉流或域名的回源流量监控数据。
body
- body payloadException
- error during requestpublic DescribeLiveMetricBandwidthDataRes describeLiveMetricBandwidthData(DescribeLiveMetricBandwidthDataBody body) throws Exception
describeLiveMetricBandwidthData
查询直播流或域名的带宽监控数据
查询一定时间范围内的直播推/拉流或域名的带宽监控数据。支持查询删除域名的带宽数据。
:::tip
本接口用于数据监控,数据采集处理方式不同于计费。如需获取对账的带宽用量,请使用 [DescribeLiveBandwidthData](https://www.volcengine.com/docs/6469/1126898)接口。
:::
body
- body payloadException
- error during requestpublic DescribeLiveMetricTrafficDataRes describeLiveMetricTrafficData(DescribeLiveMetricTrafficDataBody body) throws Exception
describeLiveMetricTrafficData
查询直播流或域名的流量监控数据
查询一定时间范围内的直播推/拉流或域名的流量监控数据。支持查询删除域名的流量数据。
:::tip
本接口用于数据监控,数据采集处理方式不同于计费。如需获取对账的流量用量,请使用 [DescribeLiveTrafficData](https://www.volcengine.com/docs/6469/1126899)接口。
:::
body
- body payloadException
- error during requestpublic DescribeLiveBatchStreamTrafficDataRes describeLiveBatchStreamTrafficData(DescribeLiveBatchStreamTrafficDataBody body) throws Exception
describeLiveBatchStreamTrafficData
查询直播流的流量数据
调用接口分页查询指定域名下所有流的上总流量、下行总流量,及每条流的流名、协议和上下行流量等信息。
body
- body payloadException
- error during requestpublic DescribeLiveBatchStreamTranscodeDataRes describeLiveBatchStreamTranscodeData(DescribeLiveBatchStreamTranscodeDataBody body) throws Exception
describeLiveBatchStreamTranscodeData
查询直播流的转码数据
调用接口分页查询指定域名下所有流的转码总量,及每条流的流名、编码格式和转码时长等信息。
body
- body payloadException
- error during requestpublic DescribeLiveStreamSessionDataRes describeLiveStreamSessionData(DescribeLiveStreamSessionDataBody body) throws Exception
describeLiveStreamSessionData
查询直播流请求数和在线人数
支持查询一定时间范围内的直播拉流的在线人数和拉流请求数,支持按拉流协议区分。支持查询删除域名的直播流请求数和在线人数。
body
- body payloadException
- error during requestpublic DescribeLiveISPDataRes describeLiveISPData() throws Exception
describeLiveISPData
查询运营商标识符
查询提供网络接入服务的运营商标识符。
Exception
- error during requestpublic DescribeLiveP95PeakBandwidthDataRes describeLiveP95PeakBandwidthData(DescribeLiveP95PeakBandwidthDataBody body) throws Exception
describeLiveP95PeakBandwidthData
查询 95 带宽峰值
支持查询用户账号维度上行和下行的 95 带宽峰值。
body
- body payloadException
- error during requestpublic DescribeLiveAuditDataRes describeLiveAuditData(DescribeLiveAuditDataBody body) throws Exception
describeLiveAuditData
查询截图审核用量
支持查询用户直播截图审核计量数据。支持按照域名维度(含删除域名)查询,数据按天粒度聚合。
body
- body payloadException
- error during requestpublic DescribeLivePullToPushBandwidthDataRes describeLivePullToPushBandwidthData(DescribeLivePullToPushBandwidthDataBody body) throws Exception
describeLivePullToPushBandwidthData
查询拉流转推带宽用量
查询一定时间范围内,直播拉流转推至第三方的带宽用量。
body
- body payloadException
- error during requestpublic DescribeLivePullToPushDataRes describeLivePullToPushData(DescribeLivePullToPushDataBody body) throws Exception
describeLivePullToPushData
查询拉流转推时长用量
创建拉流转推任务成功后,调用该接口查询拉流转推任务详细,如任务时长等。
body
- body payloadException
- error during requestpublic DescribeLiveBandwidthDataRes describeLiveBandwidthData(DescribeLiveBandwidthDataBody body) throws Exception
describeLiveBandwidthData
查询直播域名带宽用量
查询直播上行、下行(含时移分发)带宽数据。
* 支持按照域名维度(含删除域名)查询;
* 支持按照 5 分钟,1 小时和 1 天粒度聚合;
* 上行带宽峰值取 BandwidthDataList Up 最大值;
* 下行带宽峰值取 BandwidthDataList Down 最大值。
body
- body payloadException
- error during requestpublic DescribeLiveRecordDataRes describeLiveRecordData(DescribeLiveRecordDataBody body) throws Exception
describeLiveRecordData
查询直播域名录制用量
支持按照域名维度(含删除域名)查询录制用量,日录制用量为一个自然日内的录制并发路数峰值。录制用量查询支持 5 分钟、1 小时、1 天和 1 月的粒度聚合。
body
- body payloadException
- error during requestpublic DescribeLiveSnapshotDataRes describeLiveSnapshotData(DescribeLiveSnapshotDataBody body) throws Exception
describeLiveSnapshotData
查询直播域名截图张数
支持查询用户直播截图计量数据。支持按照域名维度(含删除域名)查询,数据按天粒度聚合。
body
- body payloadException
- error during requestpublic DescribeLiveTrafficDataRes describeLiveTrafficData(DescribeLiveTrafficDataBody body) throws Exception
describeLiveTrafficData
查询直播域名流量用量
查询直播上行、下行(含时移分发)流量数据。
* 支持按照域名维度(含删除域名)查询;
* 支持按照 5 分钟,1 小时和 1 天粒度聚合;
* 上行总流量为 TrafficDataList Up 取和;
* 下行总流量为 TrafficDataList Down 取和。
body
- body payloadException
- error during requestpublic DescribeLiveTranscodeDataRes describeLiveTranscodeData(DescribeLiveTranscodeDataBody body) throws Exception
describeLiveTranscodeData
查询直播域名转码用量
支持查询用户直播转码时长数据。支持按照域名维度(含删除域名)查询,按天粒度聚合。
body
- body payloadException
- error during requestpublic DescribeLiveTimeShiftDataRes describeLiveTimeShiftData(DescribeLiveTimeShiftDataBody body) throws Exception
describeLiveTimeShiftData
查询直播时移存储用量
指定时间范围,查询每日直播时移功能的存储用量。
:::warning
该接口适用于**视频直播提供时移能力**的场景,如时移文件存储于视频点播 VoD 或对象存储 ToS,请联系我们,获取用量查询方法。
:::
body
- body payloadException
- error during requestpublic DescribeLiveCustomizedLogDataRes describeLiveCustomizedLogData(DescribeLiveCustomizedLogDataBody body) throws Exception
describeLiveCustomizedLogData
查询定制化客户日志文件信息
查询定制化客户指定域名下、指定日志类型的日志文件下载链接等信息。
body
- body payloadException
- error during requestpublic DescribeLiveLogDataRes describeLiveLogData(DescribeLiveLogDataBody body) throws Exception
describeLiveLogData
查询日志文件信息
查询指定域名下、指定日志类型的日志文件下载链接等信息。
body
- body payloadException
- error during requestpublic DeleteRefererRes deleteReferer(DeleteRefererBody body) throws Exception
deleteReferer
删除 Referer 黑白名单
删除 Referer 防盗链配置。
body
- body payloadException
- error during requestpublic DescribeDenyConfigRes describeDenyConfig(DescribeDenyConfigBody body) throws Exception
describeDenyConfig
查询 IP 黑白名单
调用接口查询 IP 黑白名单配置。
body
- body payloadException
- error during requestpublic DescribeRefererRes describeReferer(DescribeRefererBody body) throws Exception
describeReferer
查询 Referer 黑白名单
查询 Referer 防盗链内容。
body
- body payloadException
- error during requestpublic UpdateDenyConfigRes updateDenyConfig(UpdateDenyConfigBody body) throws Exception
updateDenyConfig
添加或更新 IP 黑白名单
如果设置黑名单,黑名单中外 IP 会被允许访问。如果设置白名单,白名单中内 IP 允许访问。
body
- body payloadException
- error during requestpublic UpdateRefererRes updateReferer(UpdateRefererBody body) throws Exception
updateReferer
添加或更新 Referer 黑白名单
调用改接口创建Referer 防盗链,或更新 Referer 防盗链配置。
body
- body payloadException
- error during requestpublic UpdateAuthKeyRes updateAuthKey(UpdateAuthKeyBody body) throws Exception
updateAuthKey
添加或更新推拉流鉴权
添加或更新推拉流鉴权信息。更新时,会对所有的鉴权参数做**全量覆盖更新**。
body
- body payloadException
- error during requestpublic DescribeLiveActivityBandwidthDataRes describeLiveActivityBandwidthData(DescribeLiveActivityBandwidthDataBody body) throws Exception
describeLiveActivityBandwidthData
DescribeLiveActivityBandwidthData
活动带宽接口
body
- body payloadException
- error during requestpublic DescribeLiveStreamUsageDataRes describeLiveStreamUsageData(DescribeLiveStreamUsageDataBody body) throws Exception
describeLiveStreamUsageData
查询指定时间流和协议维度的数据
查询指定时间流和协议维度的带宽、在线人数和请求数接口
body
- body payloadException
- error during requestCopyright © 2024. All rights reserved.