You need to enable JavaScript to run this app.
导航
刷新缓存
最近更新时间:2024.06.25 12:54:27首次发布时间:2022.03.31 15:59:02

此接口用于在指定空间下刷新缓存。

请求说明

请求地址:https://vod.volcengineapi.com?Action=CreateCdnRefreshTask&Version=2021-01-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

参数
类型
是否必选
示例值
描述
Action
String
CreateCdnRefreshTask
接口名称。当前 API 的名称为 CreateCdnRefreshTask
Version
String
2021-01-01
接口版本。当前 API 的版本为 2021-01-01
SpaceName
String
test

点播空间名称。您可通过以下方式获取:

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
Urls
String
https://example.com

刷新 URL。每个 URL 必须以 http:// 或者 https:// 开头。多个 URL 之间需要用换行符(\n)分隔。最多输入 100 条。

注意

  • 刷新任务类型为 URL 刷新时,一个账号每日最多可刷新 1000 个 URL。
  • 刷新任务类型为目录刷新时,一个账号每日最多可刷新 50 个 URL。
Type
String
refresh_file

刷新任务类型。取值如下:

  • refresh_file:URL 刷新。
  • refresh_dir:目录刷新。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数
类型
示例值
描述
TaskId
String
6242b7c******451a4003
任务 ID。

请求示例

https://vod.volcengineapi.com?Action=CreateCdnRefreshTask&Version=2021-01-01&SpaceName=test&Urls=https://example.com&Type=refresh_file

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202203291******730982019C704",
    "Action": "CreateCdnRefreshTask",
    "Version": "2021-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "TaskId": "6242b6d******4e9451a3cff"
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码,详见视频点播公共错误码

状态码错误码错误信息说明
400InvalidParameter.InvalidAccountId-无效的账号 ID,请调整后重试。
400InvalidParameter.InvalidTaskType-刷新任务的类型必须是 URL 刷新或者目录刷新,当前输入不符合规范,请调整后重试。
400InvalidParameter.NoActionQuota-刷新配额已耗尽。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API,此 API 各语言调用的示例代码,请参考如下: