You need to enable JavaScript to run this app.
导航

关于服务端 API 接口升级至 2023-01-01 版本的公告

最近更新时间2023.12.27 11:39:45

首次发布时间2023.09.25 16:05:12

尊敬的火山引擎视频直播用户:

视频直播 API 于北京时间 2023 年 9 月 25 日全面升级至 2023-01-01 版本。 新版本接口提供了全量业务相关错误码说明,提升接口使用时的排障效率。原视频直播 2020-08-01 版本接口会根据下文维护策略所述日期,到期后不再提供技术支持,并将于北京时间 2024 年 03 月 25 日下线。

如果您的业务还在使用 2020-08-01 版本相关接口,建议您尽快将接口版本升级至 2023-01-01版本,以免对您的业务造成影响。

影响范围

  • 所有服务端 API 接口版本升级,公共参数 Version 取值由 2020-08-01 变更为 2023-01-01
  • 所有服务端 API 接口增加业务错误码示例,详见新版本接口文档
  • 部分服务端 API 接口公共参数 Action 变更。

详细说明请参见下文版本差异

维护策略

旧版本接口维护策略如下。

  • 此公告发布之日起,3 个月后(2023 年 12 月 25 日)开始不再接受增加新特性需求;
  • 此公告发布之日起,3 个月后(2023 年 12 月 25 日)不再做系统等方面的适配;
  • 此公告发布之日起,3 个月后(2023 年 12 月 25 日)不再做产品缺陷以及安全性等方面问题的修复;
  • 此公告发布之日起,6 个月后(2024 年 03 月 25 日)下线旧版本接口文档。

版本差异

接口类别
2020-08-01
2023-01-01
说明

域名管理

  • CreateDomain
  • DeleteDomain
  • DisableDomain
  • EnableDomain
  • ManagerPullPushDomainBind
  • DescribeDomain
  • ListDomainDetail
  • CreateDomain
  • DeleteDoamin
  • DisableDomain
  • EnableDomain
  • UpdateDomainVhost
  • DesvribeDomain
  • ListDomainDetail
  • CreateDomainV2
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明
  3. 新增接口:
    • CreateDomainV2,批量添加域名
    • UpdateDomainVhost,修改域名的域名空间
  4. 推拉流域名绑定(ManagerPullPushDomainBind) 接口在 2023-01-01 版本中使用修改域名的域名空间(UpdateDomainVhost) 实现,推拉流域名在同一个域名空间即为绑定关系。

证书管理

  • CreateCert
  • DeleteCert
  • BindCert
  • UnbindCert
  • ListCertV2
  • DescribeCertDetailSceretV2
  • CreateCert
  • DeleteCert
  • BindCert
  • UnbindCert
  • ListCertV2
  • DescribeCertDetailSecretV2
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

安全管理

  • UpdateAuthKey
  • DescribeAuth
  • UpdateDenyConfig
  • DescribeDenyConfig
  • UpdateReferer
  • DescribeReferer
  • DeleteReferer
  • UpdateAuthKey
  • DescribeAuth
  • UpdateDenyConfig
  • DescribeDenyConfig
  • UpdateReferer
  • DescribeReferer
  • DeleteReferer
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

限额管理

  • UpdateStreamQuotaConfig
  • DescribeStreamQuotaConfig
  • DeleteStreamQuotaConfig
  • UpdateStreamQuotaConfig
  • DescribeStreamQuotaConfig
  • DeleteStreamQuotaConfig
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

直播地址

  • GeneratePushURL
  • GeneratePlayURL
  • GeneratePushURL
  • GeneratePlayURL
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

流管理

  • DescribeLiveStreamInfoByPage
  • DescribeClosedStreamInfoByPage
  • DescribeForbiddenStreamInfoByPage
  • KillStream
  • ForbidStream
  • ResumeStream
  • DescribeLiveStreamState
  • DescribeLiveStreamInfoByPage
  • DescribeClosedStreamInfoByPage
  • DescribeForbiddenStreamInfoByPage
  • KillStream
  • ForbidStream
  • ResumeStream
  • DescribeLiveStreamState
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

转码配置

  • CreateTranscodePreset
  • DeleteTranscodePreset
  • UpdateTranscodePreset
  • ListCommonTransPresetDetail
  • ListVhostTransCodePreset
  • CreateTranscodePreset
  • DeleteTranscodePreset
  • UpdateTranscodePreset
  • ListCommonTransPresetDetail
  • ListVhostTransCodePreset
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

录制配置

  • CreateRecordPresetV2
  • DeleteRecordPreset
  • UpdateRecordPresetV2
  • ListVhostRecordPresetV2
  • DescribeRecordTaskFileHistory
  • CreateRecordPresetV2
  • DeleteRecordPreset
  • UpdateRecordPresetV2
  • ListVhostRecordPresetV2
  • DescribeRecordTaskFileHistory
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

截图配置

  • CreateSnapshotPreset
  • DeleteSnapshotPreset
  • UpdateSnapshotPreset
  • ListVhostSnapshotPreset
  • DescribeCDNSnapshotHistory
  • CreateSnapshotPreset
  • DeleteSnapshotPreset
  • UpdateSnapshotPreset
  • ListVhostSnapshotPreset
  • DescribeCDNSnapshotHistory
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

截图审核

  • CreateSnapshotAuditPreset
  • DeleteSnapshotAuditPreset
  • UpdateSnapshotAuditPreset
  • ListVhostSnapshotAuditPreset
  • CreateSnapshotAuditPreset
  • DeleteSnapshotAuditPreset
  • UpdateSnapshotAuditPreset
  • ListVhostSnapshotAuditPreset
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

拉流回源

  • UpdateRelaySourceV3
  • DeleteRelaySourceV3
  • DescribeRelaySourceV3
  • CreateRelaySourceV4
  • DeleteRelaySourceV4
  • UpdateRelaySourceV4
  • UpdateRelaySourceV3
  • DeleteRelaySourceV3
  • DescribeRelaySourceV3
  • CreateRelaySourceV4
  • DeleteRelaySourceV4
  • ListRelaySourceV4
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

直播时移

  • CreateTimeShiftPresetV3
  • DeleteTimeShiftPresetV3
  • UpdateTimeShiftPresetV3
  • ListTimeShiftPresetV2
  • CreateTimeShiftPresetV3
  • DeleteTimeShiftPresetV3
  • UpdateTimeShiftPresetV3
  • ListTimeShiftPresetV2
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

直播水印

  • CreateWatermarkPreset
  • DeleteWatermarkPreset
  • UpdateWatermarkPreset
  • ListWatermarkPreset
  • ListVhostWatermarkPreset
  • CreateWatermarkPreset
  • DeleteWatermarkPreset
  • UpdateWatermarkPreset
  • ListWatermarkPreset
  • ListVhostWatermarkPreset
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

拉流转推

  • CreatePullToPushTask
  • DeletePullToPushTask
  • UpdatePullToPushTask
  • RestartPullToPushTask
  • StopPullToPushTask
  • ListPullToPushTask
  • CreatePullToPushTask
  • DeletePullToPushTask
  • UpdatePullToPushTask
  • RestartPullToPushTask
  • StopPullToPushTask
  • ListPullToPushTask
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

用量查询

  • DescribeLiveBandwidthData
  • DescribeLiveTrafficData
  • DescribeRecordData
  • DescribeTranscodeData
  • DescribeSnapshotData
  • DescribeLiveAuditData
  • DescribePullToPushData
  • DescribeLiveTimeShiftData
  • DescribeLiveP95PeakBandwidthData
  • DescribePullToPushBandwidthData
  • DescribeLiveBandwidthData
  • DescribeLiveTrafficData
  • DescribeLiveRecordData(Action 变更)
  • DescribeLiveTranscodeData(Action 变更)
  • DescribeLiveSnapshotData(Action 变更)
  • DescribeLiveAuditData
  • DescribeLivePullToPushData
  • DescribeLiveTimeShiftData
  • DescribeLiveP95PeakBandwidthData
  • DescribeLivePullToPushBandwidthData(Action 变更)
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

统计分析

  • DescribePushStreamMetrics
  • DescribeLiveBatchPushStreamMetrics
  • DescribeLiveSourceStreamMetrics
  • DescribeLiveBatchSourceStreamMetrics
  • DescribeLiveStreamSessionData
  • DescribeLiveMetricTrafficData
  • DescribeLiveMetricBandwidthData
  • DescribeLiveSourceTrafficData
  • DescribeLiveSourceBandwidthData
  • DescribeLivePlayStatusCodeData
  • DescribeIpInfo
  • DescribeLivePushStreamMetrics(Action 变更)
  • DescribeLiveBatchPushStreamMetrics
  • DescribeLiveSourceStreamMetrics
  • DescribeLiveBatchSourceStreamMetrics
  • DescribeLiveStreamSessionData
  • DescribeLiveMetricTrafficData
  • DescribeLiveMetricBandwidthData
  • DescribeLiveSourceTrafficData
  • DescribeLiveSourceBandwidthData
  • DescribeLivePlayStatusCodeData
  • DescribeIpInfo
  • DescribeLiveStreamCountData(新增)
  • DescribeLivePushStreamCountData(新增)
  • DescribeLiveISPData(新增)
  • DescribeLiveRegionData(新增)
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

回调管理

  • UpdateCallback
  • DeleteCallback
  • DescribeCallback
  • UpdateCallback
  • DeleteCallback
  • DescribeCallback
  1. 公共传参 Version 取值变更为 2023-01-01
  2. 增加业务错误码说明

拉流录制

-

  • CreatePullRecordTask(新增)
  • StopPullRecordTask(新增)
  • ListPullRecordTask(新增)

新增接口

日志管理

  • DescribeLiveDomainLog
  • DescribeLivePullToPushLog
    -DescribeLiveAccessLog
  • DescribeLiveSourceLog

-

暂不提供

技术支持

如您在切换新版本接口或使用新版本接口使用时遇到问题,您可以通过创建工单获取技术支持。

火山引擎视频直播团队
2023 年 09 月 25 日