文档

UpdateMediaPublishState - 更新媒体发布状态

更新时间:

更新媒体发布状态。

接口说明

本接口中所指发布的含义是媒体播放资源、截图文件的访问权限设置为继承所属 Bucket 的访问权限。不发布的含义是将媒体播放资源、截图文件的访问权限设置为私有。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
MediaIdstring

需更新发布状态的媒体 ID。可以从新增媒体的返回参数中获取,也可以登录媒体处理控制台,通过媒体管理 > 媒体列表找到目标视频,单击管理,从目标视频的基础信息页签获取。

3e6149d5a8c944c09b1a8d2dc3e4****
Publishboolean

发布状态。默认值:Initialed(初始)。可选范围:

  • true:发布。
  • false:不发布。
true

媒体发布默认状态与迁移规则

默认状态:

媒体发布状态的默认值是 Initialed(初始)。有两种媒体类型处于这种状态:

  • 新的媒体:第一次生成一个媒体(第一次触发媒体工作流执行)时,工作流还处于执行中,这个时候媒体就处于“初始“状态。只要媒体工作流执行完成,就会变更为一个确切状态(根据媒体工作流的配置来设置)。
  • 删除后的媒体:媒体删除后,发布状态就没有意义了,这个时候也是处于“初始”状态。如果把删除的媒体重新添加回媒体库,就从“新的媒体”开始重新执行。

迁移规则:

说明 迁移指媒体发布状态在初始、发布、不发布三种状态之间的迁移。通过 API 调用和通过工作流执行调用的媒体迁移规则不同。
调用者当前状态迁移后状态是否允许
API初始发布不允许
API初始不发布不允许
API发布不发布允许
API不发布发布允许
工作流执行初始发布允许
工作流执行初始不发布允许
工作流执行发布不发布不允许
工作流执行不发布发布不允许

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

91B6CAB9-034C-4E4E-A40B-E7F5C81E688C

示例

正常返回示例

JSON格式

{
  "RequestId": "91B6CAB9-034C-4E4E-A40B-E7F5C81E688C"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈