创建刷新预热禁用解禁任务--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

创建刷新预热禁用解禁任务

最近更新时间：2024.08.13 17:42:23首次发布时间：2024.08.13 17:33:24

本接口支持创建一个内容管理任务（包括刷新 URL、刷新目录（包含根目录）、预热 URL、禁用 URL 以及解禁 URL）。

使用说明

如需提升刷新、预热和禁用的额度，您可在控制台的配额中心自助申请。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageContentTask`	接口名称。当前 API 的名称为 `CreateImageContentTask`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

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

参数	类型	是否必选	示例值	描述
TaskType	String	是	`refresh_url`	操作类型。取值如下所示： `refresh_url`：刷新 URL `refresh_dir`：目录刷新（支持根目录刷新） `preload_url`：预热 URL `block_url`：禁用 URL `unblock_url`：解禁 URL
Urls	Array of String	是	`["http://r.test.com/demo1.png"]`	资源 URL 或者目录。当`TaskType`取值`refresh_url`，一次可提交的最大限额为 2000 个；当`TaskType`取值`refresh_dir`，一次可提交的最大限额为 50 个；当`TaskType`取值`preload_url`，一次可提交的最大限额为 2000 个；当`TaskType`取值`block_url`，一次可提交的最大限额为 2000 个；当`TaskType`取值`unblock_url`，一次可提交的最大限额为 2000 个。
PrefixRefreshDir	Boolean	否	`false`	仅当 `TaskType` 为 `refresh_dir` 使用目录刷新时，可通过此配置开启前缀刷新。取值如下所示： `true`：开启前缀刷新 `false`：（默认）关闭前缀刷新，进行标准的目录匹配刷新。

TaskType

String

是

refresh_url

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

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

Urls

Array of String

是

["http://r.test.com/demo1.png"]

资源 URL 或者目录。

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

PrefixRefreshDir

Boolean

否

false

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

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

返回参数

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

参数	类型	示例值	描述
TaskId	String	`8279***0180`	对应的任务 ID
Msg	String	`create content task succeed`	完成结果提示信息

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageContentTask&Version=2023-05-01
{
    "TaskType": "refresh_url",
    "Urls": [
        "http://r.test.com/demo1.png"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageContentTask",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "8279***0180",
        "Msg": "create content task succeed"
    }
}

错误码

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

服务端 SDK

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

历史版本

2018-08-01 版本 CreateImageContentTask 接口文档现已停止维护，建议您参考本文档使用最新版本。