public class LiveTrait extends BaseServiceImpl
| Modifier and Type | Class and Description |
|---|---|
static class |
LiveTrait.ResponseModel |
apiInfoList, serviceInfo| Modifier | Constructor and Description |
|---|---|
protected |
LiveTrait() |
protected |
LiveTrait(org.apache.http.HttpHost proxy) |
protected |
LiveTrait(ServiceInfo serviceInfo) |
destroy, getAccessKey, getApiInfoList, getHttpClient, getISigner, getRegion, getSecretKey, getServiceInfo, getSignUrl, getWholeSignUrl, json, post, put, putData, putDataWithResponse, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSocketTimeout, signSts2protected LiveTrait()
protected LiveTrait(ServiceInfo serviceInfo)
protected LiveTrait(org.apache.http.HttpHost proxy)
public DeleteTranscodePresetRes deleteTranscodePreset(DeleteTranscodePresetBody body) throws Exception
deleteTranscodePreset
删除转码配置
调用 `DeleteTranscodePreset` 接口，删除已创建的转码配置。
body - body payloadException - error during requestpublic UpdateTranscodePresetRes updateTranscodePreset(UpdateTranscodePresetBody body) throws Exception
updateTranscodePreset
更新转码配置
调用 `UpdateTranscodePreset` 接口，更新已添加的转码配置。
body - body payloadException - error during requestpublic ListCommonTransPresetDetailRes listCommonTransPresetDetail(ListCommonTransPresetDetailBody body) throws Exception
listCommonTransPresetDetail
查询内置转码档位的详细配置
调用 `ListCommonTransPresetDetail` 接口，查询内置转码档位的详细配置。
body - body payloadException - error during requestpublic ListVhostTransCodePresetRes listVhostTransCodePreset(ListVhostTransCodePresetBody body) throws Exception
listVhostTransCodePreset
查询转码配置列表
调用 `ListVhostTransCodePreset` 接口，查询转码配置列表。
body - body payloadException - error during requestpublic CreateTranscodePresetRes createTranscodePreset(CreateTranscodePresetBody body) throws Exception
createTranscodePreset
添加转码配置
调用 `CreateTranscodePreset` 接口创建一个转码配置，在直播流传输的过程中，系统将根据您的转码配置，对直播流进行实时转码。
body - body payloadException - error during requestpublic CreateWatermarkPresetRes createWatermarkPreset(CreateWatermarkPresetBody body) throws Exception
createWatermarkPreset
添加水印配置
调用 `CreateWatermarkPreset` 接口，为转码流添加水印配置。
body - body payloadException - error during requestpublic UpdateWatermarkPresetRes updateWatermarkPreset(UpdateWatermarkPresetBody body) throws Exception
updateWatermarkPreset
更新水印配置
调用 `UpdateWatermarkPreset` 接口，更新已添加的水印配置。
body - body payloadException - error during requestpublic DeleteWatermarkPresetRes deleteWatermarkPreset(DeleteWatermarkPresetBody body) throws Exception
deleteWatermarkPreset
删除水印配置
调用 `DeleteWatermarkPreset` 接口，删除已添加的水印配置。
body - body payloadException - error during requestpublic ListWatermarkPresetRes listWatermarkPreset(ListWatermarkPresetBody body) throws Exception
listWatermarkPreset
查询水印配置
调用 `ListWatermarkPreset` 接口，查询单个水印配置的信息。
body - body payloadException - error during requestpublic ListVhostWatermarkPresetRes listVhostWatermarkPreset(ListVhostWatermarkPresetBody body) throws Exception
listVhostWatermarkPreset
查询水印配置列表
调用 `ListVhostWatermarkPreset` 接口，查询指定域名空间的所有水印配置。
body - body payloadException - error during requestpublic DeleteRecordPresetRes deleteRecordPreset(DeleteRecordPresetBody body) throws Exception
deleteRecordPreset
删除录制配置
调用 `DeleteRecordPreset` 接口，删除已创建的录制配置。
body - body payloadException - error during requestpublic UpdateRecordPresetV2Res updateRecordPresetV2(UpdateRecordPresetV2Body body) throws Exception
updateRecordPresetV2
更新录制配置
调用 `UpdateRecordPresetV2` 接口，更新已添加的录制配置。
body - body payloadException - error during requestpublic DescribeRecordTaskFileHistoryRes describeRecordTaskFileHistory(DescribeRecordTaskFileHistoryBody body) throws Exception
describeRecordTaskFileHistory
查询录制历史详情
调用 `DescribeRecordTaskFileHistory` 接口查询指定 `Vhost` 下的直播录制历史信息。包括但不限于录制时长、文件格式、开始时间、结束时间。
body - body payloadException - error during requestpublic ListVhostRecordPresetV2Res listVhostRecordPresetV2(ListVhostRecordPresetV2Body body) throws Exception
listVhostRecordPresetV2
查询录制配置列表
调用 `ListVhostRecordPresetV2` 接口，查询 Vhost 下的所有录制配置，包含 Vhost、Vhost + App、Vhost + App + Stream 三个级别的所有配置。
body - body payloadException - error during requestpublic CreateRecordPresetV2Res createRecordPresetV2(CreateRecordPresetV2Body body) throws Exception
createRecordPresetV2
添加录制配置
调用 `CreateRecordPresetV2` 接口创建一个录制配置，在直播流传输过程中，视频直播服务端将根据您直播流地址参数匹配录制配置，对直播流进行录制。
body - body payloadException - error during requestpublic DeleteSnapshotPresetRes deleteSnapshotPreset(DeleteSnapshotPresetBody body) throws Exception
deleteSnapshotPreset
删除截图配置
调用 `DeleteSnapshotPreset` 接口，删除已添加的截图配置。
body - body payloadException - error during requestpublic UpdateSnapshotPresetRes updateSnapshotPreset(UpdateSnapshotPresetBody body) throws Exception
updateSnapshotPreset
更新截图配置 V1
查询域名和应用关联的直播截图模版，并更新某截图模版的配置项。
:::tip
该接口属于历史版本 API，我们计划于 2024 年 04 月 25 日**停止对其进行维护**，并于 2024 年 07 月 25 日**下线文档**，建议您使用新版[UpdateSnapshotPresetV2](https://www.volcengine.com/docs/6469/1208857)接口。
:::
body - body payloadException - error during requestpublic DescribeCDNSnapshotHistoryRes describeCDNSnapshotHistory(DescribeCDNSnapshotHistoryBody body) throws Exception
describeCDNSnapshotHistory
查询截图历史详情
调用 `DescribeCDNSnapshotHistory` 接口，查询直播流的截图文件信息。
body - body payloadException - error during requestpublic ListVhostSnapshotPresetRes listVhostSnapshotPreset(ListVhostSnapshotPresetBody body) throws Exception
listVhostSnapshotPreset
查询截图配置列表 V1
查询域名维度下所有的 App 名称，以及 App 关联的截图模板。
:::tip
该接口属于历史版本 API，我们计划于 2024 年 04 月 25 日**停止对其进行维护**，并于 2024 年 07 月 25 日**下线文档**，建议您使用新版[ListVhostSnapshotPresetV2](https://www.volcengine.com/docs/6469/1208858)接口。
:::
body - body payloadException - error during requestpublic CreateSnapshotPresetRes createSnapshotPreset(CreateSnapshotPresetBody body) throws Exception
createSnapshotPreset
添加截图配置 V1
调用接口添加视频直播截图配置。调用后会先增加截图模版，将新建模版加入模版库中，再将该模版绑定到对应的 App 上。
:::tip
该接口属于历史版本 API，我们计划于 2024 年 04 月 25 日**停止对其进行维护**，并于 2024 年 7 月 25 日**下线文档**，建议您使用新版[CreateSnapshotPresetV2](https://www.volcengine.com/docs/6469/1208856)接口。
:::
body - body payloadException - error during requestpublic DeleteTimeShiftPresetV2Res deleteTimeShiftPresetV2(DeleteTimeShiftPresetV2Body body) throws Exception
deleteTimeShiftPresetV2
删除时移配置
本接口用于删除指定Vhost和应用下的直播时移配置。通过提供`Vhost`、`App`和`Preset`参数，可以精确删除特定的时移配置。该操作会立即生效，但不会影响已生成的时移内容。适用于时移功能下线或配置调整等场景。
body - body payloadException - error during requestpublic CreateTimeShiftPresetV2Res createTimeShiftPresetV2(CreateTimeShiftPresetV2Body body) throws Exception
createTimeShiftPresetV2
新增时移配置
调用 CreateTimeShiftPresetV2 接口，新增时移配置。
body - body payloadException - error during requestpublic UpdateTimeShiftPresetV2Res updateTimeShiftPresetV2(UpdateTimeShiftPresetV2Body body) throws Exception
updateTimeShiftPresetV2
更新时移配置
更新时移配置
body - body payloadException - error during requestpublic ListTimeShiftPresetV2Res listTimeShiftPresetV2(ListTimeShiftPresetV2Body body) throws Exception
listTimeShiftPresetV2
查询直播时移配置列表
调用 `ListTimeShiftPresetV2` 接口，查询 vhost 下指定存储类型的时移配置。
body - body payloadException - error during requestpublic DeleteCallbackRes deleteCallback(DeleteCallbackBody body) throws Exception
deleteCallback
删除回调配置
调用 `DeleteCallback` 接口，删除已创建的回调配置。
body - body payloadException - error during requestpublic DescribeCallbackRes describeCallback(DescribeCallbackBody body) throws Exception
describeCallback
查询回调配置
调用 `DescribeCallback` 接口，查询已添加的回调配置。
body - body payloadException - error during requestpublic UpdateCallbackRes updateCallback(UpdateCallbackBody body) throws Exception
updateCallback
添加或更新回调配置
调用 `UpdateCallback` 接口，添加或更新直播推流、直播断流、录制和截图的回调。使用此接口更新回调配置时，调用成功后，会对全部回调配置的参数做全量更新。
body - body payloadException - error during requestpublic DeleteCertRes deleteCert(DeleteCertBody body) throws Exception
deleteCert
删除证书
调用 `DeleteCert` 接口，通过证书链 ID 删除一个已添加的证书。
body - body payloadException - error during requestpublic DescribeCertDetailSecretV2Res describeCertDetailSecretV2(DescribeCertDetailSecretV2Body body) throws Exception
describeCertDetailSecretV2
查看证书详情
调用 `DescribeCertDetailSecretV2` 接口，通过证书 ID 或证书链 ID 查询证书详情。
body - body payloadException - error during requestpublic ListCertV2Res listCertV2(ListCertV2Body body) throws Exception
listCertV2
查询证书列表
调用 `ListCertV2` 接口，查看当前账号下的证书列表。
body - body payloadException - error during requestpublic CreateCertRes createCert(CreateCertBody body) throws Exception
createCert
添加证书
调用 `CreateCert` 接口，添加或更新一个证书，需要填写证书名称和证书内容等参数。
body - body payloadException - error during requestpublic BindCertRes bindCert(BindCertBody body) throws Exception
bindCert
绑定证书
调用 `BindCert` 接口，为域名绑定 HTTPS 证书并启用 HTTPS 协议。
body - body payloadException - error during requestpublic UnbindCertRes unbindCert(UnbindCertBody body) throws Exception
unbindCert
解绑证书
调用 `UnbindCert` 接口，解绑域名的 HTTPS 证书。
body - body payloadException - error during requestpublic DeleteDomainRes deleteDomain(DeleteDomainBody body) throws Exception
deleteDomain
删除域名
调用 `DeleteDomain` 接口，从视频直播服务中删除已添加的推/拉流域名，删除后无法使用此域名进行推拉流。
body - body payloadException - error during requestpublic EnableDomainRes enableDomain(EnableDomainBody body) throws Exception
enableDomain
启用域名
调用 `EnableDomain` 接口，启用指定的已被禁用的直播域名。启用后，您可以继续使用此域名进行推拉流，域名状态从`2-禁用状态`变为`0-正常状态`。
body - body payloadException - error during requestpublic CreateDomainV2Res createDomainV2(CreateDomainV2Body body) throws Exception
createDomainV2
批量添加域名
调用 `CreateDomainV2` 接口，批量添加域名到视频直播服务，并配置加速区域。
body - body payloadException - error during requestpublic UpdateDomainVhostRes updateDomainVhost(UpdateDomainVhostBody body) throws Exception
updateDomainVhost
更新域名的域名空间
调用 `UpdateDomainVhost` 接口，修改推流域名或拉流域名所属的域名空间。
body - body payloadException - error during requestpublic DescribeDomainRes describeDomain(DescribeDomainBody body) throws Exception
describeDomain
查询域名信息
调用 `DescribeDomain` 接口，查询域名的详细信息，包括但不限于域名所属域名空间、CNAME、类型、域名状态。
body - body payloadException - error during requestpublic ListDomainDetailRes listDomainDetail(ListDomainDetailBody body) throws Exception
listDomainDetail
查询域名列表
调用 `ListDomainDetail` 接口，根据域名状态、类别等信息，查询当前账号下的的域名列表信息。
body - body payloadException - error during requestpublic DisableDomainRes disableDomain(DisableDomainBody body) throws Exception
disableDomain
禁用域名
调用 `DisableDomain` 接口，禁用指定的直播域名。禁用后，无法使用此域名进行推拉流，且域名状态从 `0-正常状态`变为 `2-禁用状态`。
body - body payloadException - error during requestpublic CreateLiveVideoQualityAnalysisTaskRes createLiveVideoQualityAnalysisTask(CreateLiveVideoQualityAnalysisTaskBody body) throws Exception
createLiveVideoQualityAnalysisTask
创建画质测评任务
调用 `CreateLiveVideoQualityAnalysisTask` 接口，创建一个指定时长的画质测评任务。任务将根据您设置的测评间隔获取每个测评点的实时码率，并对测评点的画面画质进行评分，您可以使用查询单个画质测评任务详情接口来查看测评结果。
body - body payloadException - error during requestpublic DeleteLiveVideoQualityAnalysisTaskRes deleteLiveVideoQualityAnalysisTask(DeleteLiveVideoQualityAnalysisTaskBody body) throws Exception
deleteLiveVideoQualityAnalysisTask
删除画质测评任务
调用 `DeleteLiveVideoQualityAnalysisTask` 接口，删除画质测评任务，您可以删除已完成的和进行中的任务。
body - body payloadException - error during requestpublic GetLiveVideoQualityAnalysisTaskDetailRes getLiveVideoQualityAnalysisTaskDetail(GetLiveVideoQualityAnalysisTaskDetailBody body) throws Exception
getLiveVideoQualityAnalysisTaskDetail
查询单个画质测评任务详情
调用 `GetLiveVideoQualityAnalysisTaskDetail` 接口，查询单个画质测评任务的测评详情，包含指定截图时间获取的视频码率和画质测试分数。
body - body payloadException - error during requestpublic ListLiveVideoQualityAnalysisTasksRes listLiveVideoQualityAnalysisTasks(ListLiveVideoQualityAnalysisTasksBody body) throws Exception
listLiveVideoQualityAnalysisTasks
查询画质测评任务列表
调用 `ListLiveVideoQualityAnalysisTasks` 接口，查询画质测评任务列表信息。
body - body payloadException - error during requestpublic StopPullToPushTaskRes stopPullToPushTask(StopPullToPushTaskBody body) throws Exception
stopPullToPushTask
停用拉流转推任务
调用 `StopPullToPushTask` 接口，停用状态为未开始或生效中的拉流转推任务。
body - body payloadException - error during requestpublic CreatePullToPushTaskRes createPullToPushTask(CreatePullToPushTaskBody body) throws Exception
createPullToPushTask
创建拉流转推任务
调用 `CreatePullToPushTask` 接口，创建拉流转推任务，将其他直播源或点播视频以直播形式推送到指定地址，同时支持为转推视频添加水印。
body - body payloadException - error during requestpublic CreatePullToPushGroupRes createPullToPushGroup(CreatePullToPushGroupBody body) throws Exception
createPullToPushGroup
创建拉流转推群组
调用 `CreatePullToPushGroup` 接口，创建拉流转推任务群组，为群组绑定项目，您可以通过设置群组实现基于项目的子账号权限细分。
body - body payloadException - error during requestpublic DeletePullToPushTaskRes deletePullToPushTask(DeletePullToPushTaskBody body) throws Exception
deletePullToPushTask
删除拉流转推任务
调用 `DeletePullToPushTask` 接口，删除已创建的拉流转推任务。
body - body payloadException - error during requestpublic DeletePullToPushGroupRes deletePullToPushGroup(DeletePullToPushGroupBody body) throws Exception
deletePullToPushGroup
删除拉流转推群组
调用 `DeletePullToPushGroup` 接口，删除拉流转推群组。
body - body payloadException - error during requestpublic ContinuePullToPushTaskRes continuePullToPushTask(ContinuePullToPushTaskBody body) throws Exception
continuePullToPushTask
启用拉流转推任务
调用 `ContinuePullToPushTask` 接口，启用任务状态为已停用的拉流转推任务。
body - body payloadException - error during requestpublic UpdatePullToPushTaskRes updatePullToPushTask(UpdatePullToPushTaskBody body) throws Exception
updatePullToPushTask
更新拉流转推任务
调用 `UpdatePullToPushTask` 接口，更新拉流转推任务信息。
body - body payloadException - error during requestpublic ListPullToPushGroupRes listPullToPushGroup(ListPullToPushGroupBody body) throws Exception
listPullToPushGroup
查询拉流转推群组列表
调用 `ListPullToPushGroup` 接口，查询拉流转推任务群出列表信息。
body - body payloadException - error during requestpublic ListPullToPushTaskRes listPullToPushTask(ListPullToPushTaskQuery query) throws Exception
listPullToPushTask
获取拉流转推任务列表
调用 `ListPullToPushTask` 接口，分页查询拉流转推任务列表，支持以任务名称进行模糊查询。
query - query argumentsException - error during requestpublic ListPullToPushTaskV2Res listPullToPushTaskV2(ListPullToPushTaskV2Body body) throws Exception
listPullToPushTaskV2
获取拉流转推任务列表
调用 `ListPullToPushTaskV2` 接口，分页查询拉流转推任务列表，支持以任务名称进行模糊查询。
body - body payloadException - error during requestpublic RelaunchPullToPushTaskRes relaunchPullToPushTask(RelaunchPullToPushTaskBody body) throws Exception
relaunchPullToPushTask
重启拉流转推任务
调用 `RelaunchPullToPushTask` 接口，使拉流转推任务从头开始进行转推。
body - body payloadException - error during requestpublic DeleteRelaySourceRewriteRes deleteRelaySourceRewrite(DeleteRelaySourceRewriteBody body) throws Exception
deleteRelaySourceRewrite
删除回源改写配置
删除回源改写配置
body - body payloadException - error during requestpublic DeleteRelaySourceV3Res deleteRelaySourceV3(DeleteRelaySourceV3Body body) throws Exception
deleteRelaySourceV3
删除播放触发回源配置
调用 `DeleteRelaySourceV3` 接口，删除播放触发回源配置。
body - body payloadException - error during requestpublic UpdateRelaySourceRewriteRes updateRelaySourceRewrite(UpdateRelaySourceRewriteBody body) throws Exception
updateRelaySourceRewrite
更新回源改写配置
更新回源改写配置
body - body payloadException - error during requestpublic DescribeRelaySourceRewriteRes describeRelaySourceRewrite(DescribeRelaySourceRewriteBody body) throws Exception
describeRelaySourceRewrite
查询回源改写配置
查询回源改写配置
body - body payloadException - error during requestpublic DescribeRelaySourceV3Res describeRelaySourceV3(DescribeRelaySourceV3Body body) throws Exception
describeRelaySourceV3
查询播放触发回源配置
调用 `DescribeRelaySourceV3` 接口，查询播放触发回源配置。
body - body payloadException - error during requestpublic UpdateRelaySourceV3Res updateRelaySourceV3(UpdateRelaySourceV3Body body) throws Exception
updateRelaySourceV3
添加或更新播放触发回源配置
调用 `UpdateRelaySourceV3` 接口，添加或更新播放触发回源配置，播放触发指回源仅在有观众观看时才会触发，可以节省源服务器的带宽资源，提高系统的整体效率。
body - body payloadException - error during requestpublic KillStreamRes killStream(KillStreamBody body) throws Exception
killStream
断开直播流
调用 `KillStream` 接口，断开指定的直推在线流推流连接，断开后还可以重新推流；或断开指定的回源流的用户拉流，断开后还可以重新拉流播放。
body - body payloadException - error during requestpublic DescribeClosedStreamInfoByPageRes describeClosedStreamInfoByPage(DescribeClosedStreamInfoByPageQuery query) throws Exception
describeClosedStreamInfoByPage
查询历史流列表
调用 `DescribeClosedStreamInfoByPage` 接口，分页查询历史流信息。
query - query argumentsException - error during requestpublic DescribeLiveStreamInfoByPageRes describeLiveStreamInfoByPage(DescribeLiveStreamInfoByPageQuery query) throws Exception
describeLiveStreamInfoByPage
查询在线流列表
调用 `DescribeLiveStreamInfoByPage` 接口，分页查询在线流信息。
query - query argumentsException - error during requestpublic DescribeLiveStreamStateRes describeLiveStreamState(DescribeLiveStreamStateQuery query) throws Exception
describeLiveStreamState
查询流状态
调用 `DescribeLiveStreamState` 接口，查询直播流类型和状态。
query - query argumentsException - error during requestpublic DescribeForbiddenStreamInfoByPageRes describeForbiddenStreamInfoByPage(DescribeForbiddenStreamInfoByPageQuery query) throws Exception
describeForbiddenStreamInfoByPage
查询禁推流列表
调用 `DescribeForbiddenStreamInfoByPage` 接口，分页查询禁推流信息。
query - query argumentsException - error during requestpublic ForbidStreamRes forbidStream(ForbidStreamBody body) throws Exception
forbidStream
禁推直播流
调用 `ForbidStream` 接口，禁止直推流的推送或禁止回源流的拉流播放，支持设置禁推结束时间。
body - body payloadException - error during requestpublic ResumeStreamRes resumeStream(ResumeStreamBody body) throws Exception
resumeStream
解禁直播流
调用 `ResumeStream` 接口，解禁被禁推的直播流。
body - body payloadException - error during requestpublic GeneratePlayURLRes generatePlayURL(GeneratePlayURLBody body) throws Exception
generatePlayURL
生成拉流地址
调用 `GeneratePlayURL` 接口，生成直播拉流地址。
body - body payloadException - error during requestpublic GeneratePushURLRes generatePushURL(GeneratePushURLBody body) throws Exception
generatePushURL
生成推流地址
调用 `GeneratePushURL` 接口，生成直播推流地址。
body - body payloadException - error during requestpublic DescribeLiveTopPlayDataRes describeLiveTopPlayData(DescribeLiveTopPlayDataBody body) throws Exception
describeLiveTopPlayData
查询 TOPN 直播流或域名的流量和带宽信息
调用 `DescribeLiveTopPlayData` 接口，查询指定时间范围内 TOPN 直播流或 TOPN 域名的流量和带宽信息。
body - body payloadException - error during requestpublic DescribeLiveRegionDataRes describeLiveRegionData() throws Exception
describeLiveRegionData
查询区域标识符
调用 `DescribeLiveRegionData` 接口，查询火山引擎视频直播服务覆盖的区域标识符。获取区域标识符后您可以在支持以区域为查询维度的接口中使用区域标识符查询指定区域的维度数据。
Exception - error during requestpublic DescribeLiveSourceStreamMetricsRes describeLiveSourceStreamMetrics(DescribeLiveSourceStreamMetricsBody body) throws Exception
describeLiveSourceStreamMetrics
查询单路回源流监控数据
调用 `DescribeLiveSourceStreamMetrics` 接口，查询指定时间范围内单路回源流的音视频帧率、码率等监控数据，用于判断回源流的健康程度。
body - body payloadException - error during requestpublic DescribeLivePushStreamMetricsRes describeLivePushStreamMetrics(DescribeLivePushStreamMetricsBody body) throws Exception
describeLivePushStreamMetrics
查询单路推流监控数据
调用 `DescribeLivePushStreamMetrics` 接口，查询指定时间范围内单路直推流的音视频帧率、码率等监控数据，用于判断直播流的健康程度。
body - body payloadException - error during requestpublic DescribeLiveCallbackDataRes describeLiveCallbackData(DescribeLiveCallbackDataBody body) throws Exception
describeLiveCallbackData
查询回调记录
该接口用于查询直播推流相关的回调记录，包括回调事件类型、状态、请求与响应信息等。可用于定位直播中回调请求异常、验证回调是否成功发送等场景。
body - body payloadException - error during requestpublic DescribeLiveStreamSessionDataRes describeLiveStreamSessionData(DescribeLiveStreamSessionDataBody body) throws Exception
describeLiveStreamSessionData
查询域名或单个直播流的拉流数据
调用 `DescribeLiveStreamSessionData` 接口，查询指定时间范围内域名下所有直播流或指定直播流的请求数和最大在线人数。
body - body payloadException - error during requestpublic DescribeLivePlayStatusCodeDataRes describeLivePlayStatusCodeData(DescribeLivePlayStatusCodeDataBody body) throws Exception
describeLivePlayStatusCodeData
查询域名状态码占比
调用 `DescribeLivePlayStatusCodeData` 接口，查询指定时间范围内域名请求的状态码占比数据，包含推流请求、拉流请求和回源请求。
body - body payloadException - error during requestpublic DescribeLiveBatchPushStreamMetricsRes describeLiveBatchPushStreamMetrics(DescribeLiveBatchPushStreamMetricsBody body) throws Exception
describeLiveBatchPushStreamMetrics
查询多路推流监控数据
调用 `DescribeLiveBatchPushStreamMetrics` 接口，查询指定时间范围内指定推流域名下所有直推流或指定直推流的音视频帧率、码率等监控数据，用于判断直播流的健康程度。
body - body payloadException - error during requestpublic DescribeLiveBatchStreamTranscodeDataRes describeLiveBatchStreamTranscodeData(DescribeLiveBatchStreamTranscodeDataBody body) throws Exception
describeLiveBatchStreamTranscodeData
查询多路流的转码数据
调用 `DescribeLiveBatchStreamTranscodeData` 接口，查询指定时间范围内域名下所有转码流的转码时长、分辨率档位、编码方式等转码数据。
body - body payloadException - error during requestpublic DescribeLivePushStreamInfoDataRes describeLivePushStreamInfoData(DescribeLivePushStreamInfoDataBody body) throws Exception
describeLivePushStreamInfoData
查询推流流信息
调用 `DescribeLivePushStreamInfoData` 接口，查询已断开的推流流信息以及推流断开的原因。
body - body payloadException - error during requestpublic DescribeLiveTranscodeInfoDataRes describeLiveTranscodeInfoData(DescribeLiveTranscodeInfoDataBody body) throws Exception
describeLiveTranscodeInfoData
查询直播域名转码数据明细
调用 `DescribeLiveTranscodeInfoData` 接口，查询指定时间范围内直播域名或直播流的转码任务 ID、流名称、转码后缀、转码开始时间和结束时间数据等明细数据。
body - body payloadException - error during requestpublic DescribeLiveSourceBandwidthDataRes describeLiveSourceBandwidthData(DescribeLiveSourceBandwidthDataBody body) throws Exception
describeLiveSourceBandwidthData
查询直播流或域名的回源带宽监控数据
调用 `DescribeLiveSourceBandwidthData` 接口，查询指定时间范围内拉流域名或回源流产生的回源带宽监控数据。
:::tip
该接口属于历史版本 API，我们计划于 2025 年 02 月 18 日停止对其进行维护，并于 2025 年 05 月 18 日下线文档，建议您使用 [DescribeLiveSourceTrafficData](https://www.volcengine.com/docs/6469/1126923) 接口，查询直播流或域名的回源流量和带宽监控数据。
:::
body - body payloadException - error during requestpublic DescribeLiveSourceTrafficDataRes describeLiveSourceTrafficData(DescribeLiveSourceTrafficDataBody body) throws Exception
describeLiveSourceTrafficData
查询直播流或域名的回源流量和带宽监控数据
调用 `DescribeLiveSourceTrafficData` 接口，查询指定时间范围内拉流域名或回源流产生的回源流量和带宽监控数据。
body - body payloadException - error during requestpublic DescribeLiveMetricBandwidthDataRes describeLiveMetricBandwidthData(DescribeLiveMetricBandwidthDataBody body) throws Exception
describeLiveMetricBandwidthData
查询直播流或域名的带宽监控数据
调用 `DescribeLiveMetricBandwidthData` 接口，查询指定时间范围内直播域名或直播流的带宽监控数据。
:::tip
该接口属于历史版本 API，我们计划于 2025 年 02 月 18 日停止对其进行维护，并于 2025 年 05 月 18 日下线文档，建议您使用新版 [DescribeLiveEdgeStatData](https://www.volcengine.com/docs/6469/1399004) 接口，查询直播流的上下行流量、上下行峰值带宽和请求数。
:::
body - body payloadException - error during requestpublic DescribeLiveMetricTrafficDataRes describeLiveMetricTrafficData(DescribeLiveMetricTrafficDataBody body) throws Exception
describeLiveMetricTrafficData
查询直播流或域名的流量监控数据
调用 `DescribeLiveMetricTrafficData` 接口，查询指定时间范围内直播域名或直播流的流量监控数据。
:::tip
该接口属于历史版本 API，我们计划于 2025 年 02 月 18 日停止对其进行维护，并于 2025 年 05 月 18 日下线文档，建议您使用新版 [DescribeLiveEdgeStatData](https://www.volcengine.com/docs/6469/1399004) 接口，查询直播流的上下行流量、上下行峰值带宽和请求数。
:::
body - body payloadException - error during requestpublic DescribeLiveEdgeStatDataRes describeLiveEdgeStatData(DescribeLiveEdgeStatDataBody body) throws Exception
describeLiveEdgeStatData
查询边缘数据
调用 `DescribeLiveEdgeStatData` 接口，查询指定协议、运营商、区域、时间范围下，直播流产生的上下行流量、上下行峰值带宽和请求数等数据。
body - body payloadException - error during requestpublic DescribeLiveISPDataRes describeLiveISPData() throws Exception
describeLiveISPData
查询运营商标识符
调用 `DescribeLiveISPData` 接口，查询所有为火山引擎视频直播提供网络接入服务的运营商标识符。获取运营商标识符后您可以在支持以运营商为查询维度的接口中使用运营商标识符查询指定运营商的维度数据。
Exception - error during requestpublic DescribeLiveP95PeakBandwidthDataRes describeLiveP95PeakBandwidthData(DescribeLiveP95PeakBandwidthDataBody body) throws Exception
describeLiveP95PeakBandwidthData
查询 95 带宽峰值
调用 `DescribeLiveP95PeakBandwidthData` 接口，查询指定时间范围内直播域名产生的 95 峰值带宽用量，包含推流域名的上行 95 峰值带宽和拉流域名的下行 95 峰值带宽。
body - body payloadException - error during requestpublic DescribeLiveASRDurationDataRes describeLiveASRDurationData(DescribeLiveASRDurationDataBody body) throws Exception
describeLiveASRDurationData
查询AI字幕时长数据
调用 `DescribeLiveASRDurationData` 接口，查询 AI 语音转字幕的转换时长。
body - body payloadException - error during requestpublic DescribeLivePullToPushBandwidthDataRes describeLivePullToPushBandwidthData(DescribeLivePullToPushBandwidthDataBody body) throws Exception
describeLivePullToPushBandwidthData
查询拉流转推带宽用量
调用 `DescribeLivePullToPushBandwidthData` 接口，查询指定时间范围内拉流转推至第三方域名时产生的拉流转推带宽用量。
body - body payloadException - error during requestpublic DescribeLivePullToPushDataRes describeLivePullToPushData(DescribeLivePullToPushDataBody body) throws Exception
describeLivePullToPushData
查询拉流转推时长用量
调用 `DescribeLivePullToPushData` 接口，查询指定时间范围内产生的所有拉流转推任务进行时长用量。
body - body payloadException - error during requestpublic DescribeLiveBandwidthDataRes describeLiveBandwidthData(DescribeLiveBandwidthDataBody body) throws Exception
describeLiveBandwidthData
查询直播域名带宽用量
调用 `DescribeLiveBandwidthData` 接口，查询指定时间范围内直播域名带宽用量，包含推流域名的上行峰值带宽和拉流域名的下行峰值带宽。
body - body payloadException - error during requestpublic DescribeLiveRecordDataRes describeLiveRecordData(DescribeLiveRecordDataBody body) throws Exception
describeLiveRecordData
查询直播域名录制用量
调用 `DescribeLiveRecordData` 接口，查询指定时间范围内直播域名录制用量即录制并发路数的最大值。
body - body payloadException - error during requestpublic DescribeLiveSnapshotDataRes describeLiveSnapshotData(DescribeLiveSnapshotDataBody body) throws Exception
describeLiveSnapshotData
查询直播域名截图张数
调用 `DescribeLiveSnapshotData` 接口，查询指定时间范围内直播域名使用截图功能产生的截图张数。
body - body payloadException - error during requestpublic DescribeLiveTrafficDataRes describeLiveTrafficData(DescribeLiveTrafficDataBody body) throws Exception
describeLiveTrafficData
查询直播域名流量用量
调用 `DescribeLiveTrafficData` 接口，查询指定时间范围内直播域名流量用量，包含推流域名的上行流量数据和拉流域名的下行流量数据。
body - body payloadException - error during requestpublic DescribeLiveTranscodeDataRes describeLiveTranscodeData(DescribeLiveTranscodeDataBody body) throws Exception
describeLiveTranscodeData
查询直播域名转码用量
调用 `DescribeLiveTranscodeData` 接口，查询指定时间范围内直播域名的转码时长用量。
body - body payloadException - error during requestpublic DescribeLiveStorageSpaceDataRes describeLiveStorageSpaceData(DescribeLiveStorageSpaceDataBody body) throws Exception
describeLiveStorageSpaceData
查询直播存储用量
指定时间范围，查询每日直播时移功能的存储用量。
:::warning
该接口适用于**视频直播提供时移能力**的场景，如时移文件存储于视频点播 VoD 或对象存储 ToS，请联系我们，获取用量查询方法。
:::
body - body payloadException - error during requestpublic DescribeLiveLogDataRes describeLiveLogData(DescribeLiveLogDataBody body) throws Exception
describeLiveLogData
查询日志文件信息
调用 `DescribeLiveLogData` 接口，查询指定时间范围内指定日志类型的离线日志文件及下载信息。
body - body payloadException - error during requestpublic DeleteRefererRes deleteReferer(DeleteRefererBody body) throws Exception
deleteReferer
删除 Referer 黑白名单
调用 `DeleteReferer` 接口，删除 Referer 防盗链配置。
body - body payloadException - error during requestpublic DescribeRefererRes describeReferer(DescribeRefererBody body) throws Exception
describeReferer
查询 Referer 黑白名单
调用 `DescribeReferer` 接口，查看 Referer 防盗链配置。
body - body payloadException - error during requestpublic DescribeAuthRes describeAuth(DescribeAuthBody body) throws Exception
describeAuth
查询推拉流鉴权
调用 `DescribeAuth` 接口，查询推拉流域名的 URL 鉴权配置。
body - body payloadException - error during requestpublic UpdateRefererRes updateReferer(UpdateRefererBody body) throws Exception
updateReferer
添加或更新 Referer 黑白名单
调用 `UpdateReferer` 接口，添加或更新 Referer 防盗链配置。
body - body payloadException - error during requestpublic UpdateAuthKeyRes updateAuthKey(UpdateAuthKeyBody body) throws Exception
updateAuthKey
添加或更新推拉流鉴权
调用 `UpdateAuthKey` 接口，为推拉流域名创建或更新 URL 鉴权配置。使用此接口更新鉴权配置时，调用成功后，会对全部鉴权参数做全量更新。
body - body payloadException - error during requestpublic DeleteHLSConfigRes deleteHLSConfig(DeleteHLSConfigBody body) throws Exception
deleteHLSConfig
删除HLS切片配置
删除HLS切片配置
body - body payloadException - error during requestpublic UpdateHLSConfigRes updateHLSConfig(UpdateHLSConfigBody body) throws Exception
updateHLSConfig
更新HLS切片配置
更新HLS切片配置
body - body payloadException - error during requestpublic DescribeHLSConfigRes describeHLSConfig(DescribeHLSConfigBody body) throws Exception
describeHLSConfig
查询HLS切片配置
查询HLS切片配置
body - body payloadException - error during requestpublic DeleteHTTPHeaderConfigRes deleteHTTPHeaderConfig(DeleteHTTPHeaderConfigBody body) throws Exception
deleteHTTPHeaderConfig
删除 HTTP Header 配置
调用 `DeleteHTTPHeaderConfig` 接口，删除拉流域名的 HTTP Header 配置。
body - body payloadException - error during requestpublic EnableHTTPHeaderConfigRes enableHTTPHeaderConfig(EnableHTTPHeaderConfigBody body) throws Exception
enableHTTPHeaderConfig
启用或禁用 HTTP Header 配置
调用 `EnableHTTPHeaderConfig` 接口，启用或禁用拉流域名的 HTTP Header 配置。
body - body payloadException - error during requestpublic DescribeHTTPHeaderConfigRes describeHTTPHeaderConfig(DescribeHTTPHeaderConfigBody body) throws Exception
describeHTTPHeaderConfig
查询 HTTP Header 配置
调用 `DescribeHTTPHeaderConfig` 接口，查询拉流域名的 HTTP Header 配置。
body - body payloadException - error during requestpublic UpdateHTTPHeaderConfigRes updateHTTPHeaderConfig(UpdateHTTPHeaderConfigBody body) throws Exception
updateHTTPHeaderConfig
添加或更新 HTTP header 配置
调用 `UpdateHTTPHeaderConfig` 接口，为拉流域名添加或更新 HTTP Header 配置。HTTP Header 配置包括在响应拉流请求时的响应 Header 配置和在请求回源服务器时的请求头 Header 配置。
body - body payloadException - error during requestpublic UpdateEncryptDRMRes updateEncryptDRM(UpdateEncryptDRMBody body) throws Exception
updateEncryptDRM
更新 DRM 证书管理平台访问密钥和 FairPlay 证书
调用 `UpdateEncryptDRM` 接口，更新 DRM 证书管理平台访问密钥和 FairPlay 证书。
body - body payloadException - error during requestpublic UpdateEncryptHLSRes updateEncryptHLS(UpdateEncryptHLSBody body) throws Exception
updateEncryptHLS
更新 HLS 密钥获取配置
调用 `UpdateEncryptHLS` 接口，添加或更新 HLS 标准加密使用的自建密钥管理服务地址和视频直播更新密钥的周期。
body - body payloadException - error during requestpublic GetHLSEncryptDataKeyRes getHLSEncryptDataKey(GetHLSEncryptDataKeyQuery query) throws Exception
getHLSEncryptDataKey
查询 HLS 加密密钥
调用 `GetHLSEncryptDataKey` 接口，查询视频直播服务端生成的用于 HLS 标准加密使用的密钥。
query - query argumentsException - error during requestpublic DescribeEncryptHLSRes describeEncryptHLS() throws Exception
describeEncryptHLS
查询 HLS 密钥获取配置
调用 `DescribeEncryptHLS` 接口，查询 HLS 标准加密使用的自建密钥管理服务地址和视频直播更新密钥的周期。
Exception - error during requestpublic DescribeLicenseDRMRes describeLicenseDRM(DescribeLicenseDRMQuery query) throws Exception
describeLicenseDRM
获取 DRM 授权许可文件
调用 `DescribeLicenseDRM` 接口，视频直播服务向 DRM 证书管理平台发起请求获取 DRM 授权许可文件。
query - query argumentsException - error during requestpublic DescribeCertDRMRes describeCertDRM(DescribeCertDRMQuery query) throws Exception
describeCertDRM
获取 FairPlay 证书文件
调用 `DescribeCertDRM` 接口，获取 FairPlay 证书文件。
query - query argumentsException - error during requestpublic DescribeEncryptDRMRes describeEncryptDRM() throws Exception
describeEncryptDRM
查看 DRM 证书管理平台访问密钥和 FairPlay 证书
调用 `DescribeEncryptDRM` 接口，查看已配置的 DRM 证书管理平台访问密钥和 FairPlay 证书信息。
Exception - error during requestpublic BindEncryptDRMRes bindEncryptDRM(BindEncryptDRMBody body) throws Exception
bindEncryptDRM
添加或更新加密配置
调用 `BindEncryptDRM` 接口，添加或更新直播加密配置。
body - body payloadException - error during requestpublic UnBindEncryptDRMRes unBindEncryptDRM(UnBindEncryptDRMBody body) throws Exception
unBindEncryptDRM
删除加密配置
调用 `UnBindEncryptDRM` 接口，删除已创建的加密配置。
body - body payloadException - error during requestpublic ListBindEncryptDRMRes listBindEncryptDRM(ListBindEncryptDRMBody body) throws Exception
listBindEncryptDRM
查询加密配置
调用 `ListBindEncryptDRM` 接口，查询指定域名空间和应用名称的加密配置或查看指定域名空间下所有加密配置。
body - body payloadException - error during requestpublic CreateTranscodePresetBatchRes createTranscodePresetBatch(CreateTranscodePresetBatchBody body) throws Exception
createTranscodePresetBatch
批量创建 ABR 子流转码配置
调用 `CreateTranscodePresetBatch` 接口批量创建 ABR 子流转码配置。
body - body payloadException - error during requestpublic DeleteTranscodePresetBatchRes deleteTranscodePresetBatch(DeleteTranscodePresetBatchBody body) throws Exception
deleteTranscodePresetBatch
批量删除 ABR 子流转码配置
调用 `DeleteTranscodePresetBatch` 接口批量删除 ABR 子流的转码配置。
body - body payloadException - error during requestpublic DeleteIPAccessRuleRes deleteIPAccessRule(DeleteIPAccessRuleBody body) throws Exception
deleteIPAccessRule
删除ip访问限制
调用 `DeleteIPAccessRule` 接口，删除域名的 IP 访问限制。
body - body payloadException - error during requestpublic DeleteRegionAccessRuleRes deleteRegionAccessRule(DeleteRegionAccessRuleBody body) throws Exception
deleteRegionAccessRule
删除地域访问限制配置
body - body payloadException - error during requestpublic UpdateIPAccessRuleRes updateIPAccessRule(UpdateIPAccessRuleBody body) throws Exception
updateIPAccessRule
更新ip访问限制
调用 `UpdateIPAccessRule` 接口，创建或更新域名的 IP 访问限制。
body - body payloadException - error during requestpublic UpdateRegionAccessRuleRes updateRegionAccessRule(UpdateRegionAccessRuleBody body) throws Exception
updateRegionAccessRule
更新地域访问限制配置
body - body payloadException - error during requestpublic DescribeIPAccessRuleRes describeIPAccessRule(DescribeIPAccessRuleBody body) throws Exception
describeIPAccessRule
查询ip访问限制
调用 `DescribeIPAccessRule` 接口，查询域名的 IP 访问限制配置。
body - body payloadException - error during requestpublic DescribeRegionAccessRuleRes describeRegionAccessRule(DescribeRegionAccessRuleBody body) throws Exception
describeRegionAccessRule
查询地域访问限制配置
body - body payloadException - error during requestpublic DeleteCMAFConfigRes deleteCMAFConfig(DeleteCMAFConfigBody body) throws Exception
deleteCMAFConfig
删除CMAF切片设置
删除CMAF切片设置
body - body payloadException - error during requestpublic UpdateCMAFConfigRes updateCMAFConfig(UpdateCMAFConfigBody body) throws Exception
updateCMAFConfig
更新CMAF切片设置
更新CMAF切片设置
body - body payloadException - error during requestpublic DescribeCMAFConfigRes describeCMAFConfig(DescribeCMAFConfigBody body) throws Exception
describeCMAFConfig
查询CMAF切片设置
查询CMAF切片设置
body - body payloadException - error during requestpublic DeleteLatencyConfigRes deleteLatencyConfig(DeleteLatencyConfigBody body) throws Exception
deleteLatencyConfig
删除延迟配置
删除延迟配置
body - body payloadException - error during requestpublic DescribeLatencyConfigRes describeLatencyConfig(DescribeLatencyConfigBody body) throws Exception
describeLatencyConfig
查询延迟配置
查询延迟配置
body - body payloadException - error during requestpublic UpdateLatencyConfigRes updateLatencyConfig(UpdateLatencyConfigBody body) throws Exception
updateLatencyConfig
添加或更新延迟配置
延迟配置更新
body - body payloadException - error during requestpublic CreateCloudMixTaskRes createCloudMixTask(CreateCloudMixTaskBody body) throws Exception
createCloudMixTask
创建云端混流任务
调用 `CreateCloudMixTask` 接口，创建云端混流任务，支持将直播流、点播视频和图片等输入源重新布局混流后推送到指定推流地址。
body - body payloadException - error during requestpublic UpdateCloudMixTaskRes updateCloudMixTask(UpdateCloudMixTaskBody body) throws Exception
updateCloudMixTask
更新云端混流任务
调用 `UpdateCloudMixTask` 接口，更新运行中的云端混流任务。
body - body payloadException - error during requestpublic GetCloudMixTaskDetailRes getCloudMixTaskDetail(GetCloudMixTaskDetailBody body) throws Exception
getCloudMixTaskDetail
查看云端混流任务
调用 `GetCloudMixTaskDetail` 接口，查看云端混流任务详细信息。
body - body payloadException - error during requestpublic ListCloudMixTaskRes listCloudMixTask(ListCloudMixTaskBody body) throws Exception
listCloudMixTask
查看云端混流任务列表
调用 `ListCloudMixTask` 接口，查看云端混流任务列表。
body - body payloadException - error during requestpublic DeleteCloudMixTaskRes deleteCloudMixTask(DeleteCloudMixTaskBody body) throws Exception
deleteCloudMixTask
结束云端混流任务
调用 `DeleteCloudMixTask` 接口，结束正在进行中的云端混流任务。
body - body payloadException - error during requestpublic DeleteClusterRateLimitRes deleteClusterRateLimit(DeleteClusterRateLimitBody body) throws Exception
deleteClusterRateLimit
DeleteClusterRateLimit
body - body payloadException - error during requestpublic DescribeClusterRateLimitRes describeClusterRateLimit(DescribeClusterRateLimitBody body) throws Exception
describeClusterRateLimit
DescribeClusterRateLimit
body - body payloadException - error during requestpublic UpdateClusterRateLimitRes updateClusterRateLimit(UpdateClusterRateLimitBody body) throws Exception
updateClusterRateLimit
UpdateClusterRateLimit
body - body payloadException - error during requestpublic DeleteUserAgentAccessRuleRes deleteUserAgentAccessRule(DeleteUserAgentAccessRuleBody body) throws Exception
deleteUserAgentAccessRule
DeleteUserAgentAccessRule
body - body payloadException - error during requestpublic DescribeUserAgentAccessRuleRes describeUserAgentAccessRule(DescribeUserAgentAccessRuleBody body) throws Exception
describeUserAgentAccessRule
DescribeUserAgentAccessRule
body - body payloadException - error during requestpublic UpdateUserAgentAccessRuleRes updateUserAgentAccessRule(UpdateUserAgentAccessRuleBody body) throws Exception
updateUserAgentAccessRule
UpdateUserAgentAccessRule
body - body payloadException - error during requestpublic DeleteFormatAccessRuleRes deleteFormatAccessRule(DeleteFormatAccessRuleBody body) throws Exception
deleteFormatAccessRule
DeleteFormatAccessRule
body - body payloadException - error during requestpublic DescribeFormatAccessRuleRes describeFormatAccessRule(DescribeFormatAccessRuleBody body) throws Exception
describeFormatAccessRule
DescribeFormatAccessRule
body - body payloadException - error during requestpublic UpdateFormatAccessRuleRes updateFormatAccessRule(UpdateFormatAccessRuleBody body) throws Exception
updateFormatAccessRule
UpdateFormatAccessRule
body - body payloadException - error during requestpublic DeleteSubtitleTranscodePresetRes deleteSubtitleTranscodePreset(DeleteSubtitleTranscodePresetBody body) throws Exception
deleteSubtitleTranscodePreset
删除字幕配置
调用 `DeleteSubtitleTranscodePreset` 接口，删除已添加的字幕配置。
body - body payloadException - error during requestpublic UpdateSubtitleTranscodePresetRes updateSubtitleTranscodePreset(UpdateSubtitleTranscodePresetBody body) throws Exception
updateSubtitleTranscodePreset
更新字幕配置
调用 `UpdateSubtitleTranscodePreset` 接口，更新已添加的字幕配置。
body - body payloadException - error during requestpublic ListVhostSubtitleTranscodePresetRes listVhostSubtitleTranscodePreset(ListVhostSubtitleTranscodePresetBody body) throws Exception
listVhostSubtitleTranscodePreset
查询字幕配置列表
调用 `ListVhostSubtitleTranscodePreset` 接口，查询指定域名空下所有字幕配置列表。
body - body payloadException - error during requestpublic CreateSubtitleTranscodePresetRes createSubtitleTranscodePreset(CreateSubtitleTranscodePresetBody body) throws Exception
createSubtitleTranscodePreset
添加字幕配置
调用 `CreateSubtitleTranscodePreset` 接口，为转码流添加字幕配置。
body - body payloadException - error during requestpublic CreateCarouselTaskRes createCarouselTask(CreateCarouselTaskBody body) throws Exception
createCarouselTask
创建轮播任务
调用 `CreateCarouselTask` 接口创建一个轮播任务，在直播过程中，视频直播服务端将根据任务配置按设定顺序循环播放指定视频内容。
body - body payloadException - error during requestpublic DeleteCarouselTaskRes deleteCarouselTask(DeleteCarouselTaskBody body) throws Exception
deleteCarouselTask
删除轮播任务
调用 `DeleteCarouselTask` 接口删除指定的轮播任务，任务删除后，系统将停止播放该任务的所有轮播内容并释放相关资源。
body - body payloadException - error during requestpublic UpdateCarouselTaskRes updateCarouselTask(UpdateCarouselTaskBody body) throws Exception
updateCarouselTask
更新轮播任务
调用 `UpdateCarouselTask` 接口修改指定的轮播任务配置，调整播放内容、播放规则或时间范围，更新后系统将按新配置执行轮播任务。
body - body payloadException - error during requestpublic GetCarouselDetailRes getCarouselDetail(GetCarouselDetailBody body) throws Exception
getCarouselDetail
查询轮播任务
调用 `GetCarouselDetail` 接口查询指定轮播任务的详细信息，包括播放状态、视频列表及当前播放进度，便于管理和监控任务执行情况。
body - body payloadException - error during requestpublic ListCarouselTaskRes listCarouselTask(ListCarouselTaskBody body) throws Exception
listCarouselTask
遍历轮播任务
调用 `ListCarouselTask` 接口获取当前所有轮播任务的列表，包括任务 ID、状态及创建时间，可用于任务管理及批量查询。
body - body payloadException - error during requestpublic DeleteRemoteAuthRes deleteRemoteAuth(DeleteRemoteAuthBody body) throws Exception
deleteRemoteAuth
删除远程鉴权配置
调用 `DeleteRemoteAuth` 接口，删除已添加的远程鉴权配置。
body - body payloadException - error during requestpublic DescribeRemoteAuthRes describeRemoteAuth(DescribeRemoteAuthBody body) throws Exception
describeRemoteAuth
查询远程鉴权配置
调用 `DescribeRemoteAuth` 接口，查询拉流域名的远程鉴权配置。
body - body payloadException - error during requestpublic ListVhostRemoteAuthRes listVhostRemoteAuth(ListVhostRemoteAuthBody body) throws Exception
listVhostRemoteAuth
查询远程鉴权配置列表
调用 `ListVhostRemoteAuth` 接口，查询 Vhost 下所有拉流域名的远程鉴权配置。
body - body payloadException - error during requestpublic UpdateRemoteAuthRes updateRemoteAuth(UpdateRemoteAuthBody body) throws Exception
updateRemoteAuth
添加或更新远程鉴权配置
调用 `UpdateRemoteAuth` 接口，为拉流域名创建远程鉴权配置，创建成功后用户拉流请求将被发送至指定的鉴权服务器，由鉴权服务器对用户拉流请求进行校验。
body - body payloadException - error during requestCopyright © 2025. All rights reserved.