全部产品
Search

搜索本产品

    视频点播：RefreshVodObjectCaches - 刷新缓存

    文档中心

    视频点播：RefreshVodObjectCaches - 刷新缓存

    更新时间：Nov 05, 2024

    调用本接口刷新节点上的文件内容。指定URL内容刷新至Cache节点，支持URL批量刷新。

    接口说明

    说明
  • 目前服务地址仅支持：华东 2（上海）。
  • 同一账号每天最多可提交刷新 URL 请求共 2000 条，刷新目录共 100 个。
  • 刷新预热类接口包含 RefreshVodObjectCaches 刷新接口和 PreloadVodObjectCaches 预热接口。
    •

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    vod:RefreshVodObjectCachesupdate
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    ObjectPathstring是

    预热文件 URL。多个 URL 使用换行符（\n 或\r\n）分隔。

    		abc.com/image/1.png
    ObjectTypestring否

    刷新的类型。取值：

    • File（默认值）：文件刷新。
    • Directory：目录刷新。
    • Regex：正则刷新。
    • IgnoreParams：去参数刷新。去参数指的是去除请求 URL 中?及?之后的参数，去参数刷新指的是用户先通过接口提交去参数后的 URL，然后用户提交的待刷新 URL 将会与已缓存资源的 URL 进行去参数匹配，如果已缓存资源的 URL 去参数以后与待刷新 URL 匹配，那么 CDN 节点将对缓存资源执行刷新处理。
    		File
    Forceboolean否

    当回源内容和源站资源对比后不一致时，是否刷新对应目录下的资源。默认为 false。

    • true：刷新对应目录下的全部资源。选择 “刷新全部资源” 时，如果用户请求的内容匹配到了目录下的资源，CDN 节点将会直接回源拉取新资源返回给用户，并重新缓存该资源。
    • false：刷新对应目录下发生变更的资源。选择 “刷新变更资源” 时，如果用户请求的内容匹配到了目录下的资源，CDN 节点将会回源获取资源的 Last-Modified 信息，若与当前缓存资源一致，则直接返回已缓存资源，若不一致，则回源拉取新资源返回给用户，并重新缓存该资源。

    返回参数

    名称类型描述示例值
    object
    RefreshTaskIdstring

    刷新返回的任务 ID。多个任务 ID 用半角逗号（,）分隔。 刷新返回的任务 ID 会按照以下两条规则对刷新任务做合并：

    同一个域名、同一秒钟提交的刷新任务（URL 颗粒度）会被合并为同一个 RefreshTaskId。 同一个域名、同一秒钟提交的刷新任务（URL 颗粒度）如果超过 2000 条，那么会按照每 2000 条合并为一个 RefreshTaskId 的方式处理。

    		70422*****2904
    RequestIdstring

    请求 ID。

    		D61E4801-EAFF-4A63-****-FBF6CE1CFD1C

    示例

    正常返回示例

    JSON格式

    {
  "RefreshTaskId": "70422*****2904",
  "RequestId": "D61E4801-EAFF-4A63-****-FBF6CE1CFD1C"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-04-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情

    接口错误码

    下表列举了本接口特有的错误码。

    错误代码错误信息HTTP 状态码说明
    ThrottlingRequest was denied due to request throttling.503请求被流量控制限制。
    IllegalOperationIllegal domain operate is not permitted.403非法域名, 无法操作
    OperationDeniedYour account does not open VOD service yet.403账号未开通视频点播服务。
    OperationDenied.SuspendedYour VOD service is suspended.403账号已欠费，请充值。
    InvalidDomain.NotFoundThe domain provided does not belong to you.404域名不存在或不属于当前用户。
    InvalidDomain.OfflineThe domain provided is offline.404域名已下线。
    QuotaExceeded.RefreshYou’ve exceeded the prescribed refresh limits.400超出当日刷新限制。
    ServiceBusyThe specified Domain is configuring, please retry later.403域名正在配置中, 请稍后再试。
    InvalidDomain.Configure_failedFailed to configure the provided domain.500域名配置失败, 无法刷新。
    MissingParameterThe input parameter “ObjectPath” that is mandatory for processing this request is not supplied.400缺少 ObjectPath 参数。
    InvalidObjectType.ValueNotSupportedThe specified value of "" is not supported.400不支持指定的 ObjectType 值。
    InvalidObjectPath.MalformedThe specific value of parameter ObjectPath is malformed.400ObjectPath 值格式错误。
    InvalidExtensiveDomain.ValueNotSupportedExtensive domain not supported.400不支持泛域名。
    QuotaPerMinuteExceeded.RefreshYou’ve exceeded the prescribed refresh limits per minute.400超出每分钟刷新限制。