更新媒体发布状态。
接口说明
本接口中所指发布的含义是媒体播放资源、截图文件的访问权限设置为继承所属 Bucket 的访问权限。不发布的含义是将媒体播放资源、截图文件的访问权限设置为私有。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| mts:UpdateMediaPublishState | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MediaId | string | 是 | 需更新发布状态的媒体 ID。可以从新增媒体的返回参数中获取，也可以登录媒体处理控制台，通过媒体管理 > 媒体列表找到目标视频，单击管理，从目标视频的基础信息页签获取。 | 3e6149d5a8c944c09b1a8d2dc3e4**** |
| Publish | boolean | 否 | 发布状态。默认值：Initialed（初始）。可选范围：
| true |
媒体发布默认状态与迁移规则
默认状态：
媒体发布状态的默认值是 Initialed（初始）。有两种媒体类型处于这种状态：
- 新的媒体：第一次生成一个媒体（第一次触发媒体工作流执行）时，工作流还处于执行中，这个时候媒体就处于“初始“状态。只要媒体工作流执行完成，就会变更为一个确切状态（根据媒体工作流的配置来设置）。
- 删除后的媒体：媒体删除后，发布状态就没有意义了，这个时候也是处于“初始”状态。如果把删除的媒体重新添加回媒体库，就从“新的媒体”开始重新执行。
迁移规则：
说明
迁移指媒体发布状态在初始、发布、不发布三种状态之间的迁移。通过 API 调用和通过工作流执行调用的媒体迁移规则不同。
| 调用者 | 当前状态 | 迁移后状态 | 是否允许 |
|---|---|---|---|
| API | 初始 | 发布 | 不允许 |
| API | 初始 | 不发布 | 不允许 |
| API | 发布 | 不发布 | 允许 |
| API | 不发布 | 发布 | 允许 |
| 工作流执行 | 初始 | 发布 | 允许 |
| 工作流执行 | 初始 | 不发布 | 允许 |
| 工作流执行 | 发布 | 不发布 | 不允许 |
| 工作流执行 | 不发布 | 发布 | 不允许 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "91B6CAB9-034C-4E4E-A40B-E7F5C81E688C"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史