You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /veImageX/API 参考/刷新/预热/禁用/解禁/创建刷新/预热/禁用/解禁任务
创建刷新/预热/禁用/解禁任务
最近更新时间：2024.05.27 15:00:09首次发布时间：2021.02.23 10:42:24
我的收藏

本接口支持在指定服务 ID 、待更改操作的文件和文件操作类型（刷新 URL、刷新目录（包含根目录）、预热 URL、禁用 URL 和解禁 URL）后创建相关文件管理任务。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 超时时间：超时时间约为 5 秒。
  • 服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

  • 请求方式：POST
  • 请求地址：https://imagex.volcengineapi.com/?Action=CreateImageContentTask&Version=2018-08-01

请求参数

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

参数类型是否必选示例值描述
X-Top-Account-IdString是1900**000账号 ID
Content-TypeString是application/json请求头字段

Query

参数类型是否必选示例值描述
ActionString是CreateImageContentTask接口名称。当前 API 的名称为 CreateImageContentTask。
VersionString是2018-08-01接口版本。当前 API 的版本为 2018-08-01。

ServiceId

String

是

8g**9j

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面，在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数类型是否必选示例值描述

TaskType

String

是

refresh_url

操作类型。取值如下所示：

  • refresh_url：刷新 URL
  • refresh_dir：目录刷新（支持根目录刷新）
  • preload_url：预热 URL
  • block_url：禁用 URL
  • unblock_url：解禁 URL

Urls

Array of String

是

https://www.a.com/1.jpg

资源 URL 或者目录。

  • 当TaskType取值refresh_url，一次可提交的最大限额为 2000 个；
  • 当TaskType取值refresh_dir，一次可提交的最大限额为 50 个；
  • 当TaskType取值preload_url，一次可提交的最大限额为 2000 个；
  • 当TaskType取值block_url，一次可提交的最大限额为 2000 个；
  • 当TaskType取值unblock_url，一次可提交的最大限额为 2000 个。

PrefixRefreshDir

Boolean

否

true

仅当 TaskType 为 refresh_dir 使用目录刷新时，可通过此配置开启前缀刷新。取值如下所示：

  • true：开启前缀刷新
  • false：（默认）关闭前缀刷新，进行标准的目录匹配刷新。

返回参数

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

参数类型示例值描述
MsgStringcreate content task succeed完成结果提示信息
TaskIdString8279***0180对应的任务 ID

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageContentTask&Version=2018-08-01&ServiceId=8g%2A%2A9j
{
  "TaskType": "block_url",
  "Urls": [
    "http://r.test.com/772edb133f7b"
  ],
  "PrefixRefreshDir": false
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230308131511B4378236E5E16B1073F8",
    "Action": "CreateImageContentTask",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "Msg": "create content task succeed",
    "TaskId": "*******"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：