调用RefreshMediaPlayUrls通过音视频ID发起音视频刷新或预热任务。
接口说明
- 视频点播提供资源的刷新和预热功能,通过刷新功能,您可以删除 CDN 节点上已经缓存的资源,并强制 CDN 节点回源站获取最新资源;通过预热功能,您可以在业务高峰前预热热门资源,提前将热门资源下载并缓存到 CDN 节点,提高资源的访问效率。
- 本接口直接通过音/视频 ID 发起刷新或预热任务,且支持筛选播放流格式及清晰度等,满足用户按需选择合适的播放流进行刷新预热的需求。
- 最多支持一次发起 20 个音/视频的刷新或预热任务。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vod:RefreshMediaPlayUrls | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MediaIds | string | 是 | 需要刷新或预热的音/视频 ID。支持设置一个或多个,多个 ID 之前使用半角逗号(,)分隔,最多支持 20 个。 音/视频 ID 可通过以下方式获取:
| ca3a8f6e4957b658067095869****, a6e49sfgd23p5g9ja7095863**** |
TaskType | string | 是 | 提交的任务类型。取值:
| Preload |
Formats | string | 否 | 设置需要刷新或预热的播放流格式。支持设置多个格式,多个格式之间使用半角逗号(,)分隔。若不设置,则默认刷新或预热所有格式的播放流。支持的格式如下:
| mp4,m3u8 |
Definitions | string | 否 | 设置需要刷新或预热的播放流清晰度。支持设置多个清晰度,多个清晰度之间使用半角逗号(,)分隔。若不设置,则默认刷新或预热所有清晰度的播放流。 说明
取值必须为媒资参数说明中清晰度:Definition所定义的取值。
| HD, SD |
StreamType | string | 否 | 设置需要刷新或预热的播放流类型。支持设置多个播放流类型,多个播放流类型之间使用半角逗号(,)分隔。若不设置,则默认刷新或预热所有的播放流类型。取值:
| video |
ResultType | string | 否 | 设置刷新或预热的结果类型。取值:
| Single |
SliceFlag | boolean | 否 | 设置是否刷新或预热 M3U8 播放流的 TS 文件的播放链接。取值:
| false |
SliceCount | integer | 否 | 设置刷新或预热 M3U8 播放流的 TS 文件播放链接的个数。每个 M3U8 播放流仅会刷新前 N 个 TS 文件的播放链接。取值范围为 1~20,默认值为 5。 | 5 |
UserData | string | 否 | {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}} |
返回参数
示例
正常返回示例
JSON
格式
{
"MediaRefreshJobId": "41d465e31957****",
"NonExistMediaIds": "ca3a8f6e4957b658067095869****",
"ForbiddenMediaIds": "a6e49sfgd23p5g9ja7095863****",
"RequestId": "25818875-5F78-4AF6-04D5-D7393642****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-03-31 | 新增 OpenAPI | 查看变更详情 |