获取任务详情--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取任务详情

最近更新时间：2024.08.13 17:38:58首次发布时间：2024.08.13 17:38:58

本接口支持查询近 30 天内内容管理任务详情列表。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
TaskType	String	否	`refresh_url`	内容管理任务类型，缺省情况下表示查询全部任务。取值如下所示： `refresh`：刷新任务，包含刷新 URL 和刷新目录。 `refresh_url`：刷新 URL `block_url`：禁用 URL `unblock_url`：解禁 URL `preload_url`：预热 URL `refresh_dir`：目录刷新（支持根目录刷新）
TaskId	String	否	`123***89`	待查询任务 ID
State	String	否	`succeed`	内容管理资源状态，取值如下所示： `submitting`：提交中 `running`：执行中 `succeed`：成功 `failed`：失败
Order	String	否	`asc`	按时间排序，取值如下所示： `asc`：正序 `desc`：逆序
StartTime	Long	是	`1721703949`	查询开始时间，unix 时间戳，单位为秒。
EndTime	Long	是	`1721703964`	查询结束时间，unix 时间戳，单位为秒。
Domain	String	否	`test.example.com`	域名，指定后返回包含该域名的 URL 任务。
Url	String	否	`http://test.example.com/demo.png`	资源 URL 或者目录，可精确匹配，取值为空时表示查询全部任务。
PageNum	Integer	否	`1`	页码，系统将仅返回该页面上的任务。默认值为 1。
PageSize	Integer	否	`10`	每页条数，取值范围为 [10,1000]。默认值为 100。

返回参数

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

参数	类型	示例值	描述
Total	Integer	`1`	总记录数
PageNum	Integer	`1`	当前页码
PageSize	Integer	`10`	每页最大记录数
Data	Array of Data	`-`	具体数据

Data

参数	类型	示例值	描述
Url	String	`http://test.example.com/demo.png`	任务指定的 URL 或目录
TaskType	String	`refresh_url`	资源任务类型，取值如下所示： `refresh`：刷新任务 `refresh_url`：刷新 URL `block_url`：禁用 URL `unblock_url`：解禁 URL `preload_url`：预热 URL `refresh_dir`：目录刷新
TaskId	String	`******`	任务 ID
State	String	`succeed`	资源任务状态，取值如下所示： `submitting`：提交中 `running`：执行中 `succeed`：成功 `failed`：失败
Process	String	`100%`	任务进度
CreateTime	Long	`1721703949`	任务的创建时间
UpdateTime	Long	`1721703964`	任务的更新时间
Msg	String	`-`	完成结果提示信息

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageContentTaskDetail&Version=2023-05-01
{
    "TaskType": "refresh_url",
    "TaskId": "123***89"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageContentTaskDetail",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 1,
        "PageNum": 1,
        "PageSize": 10,
        "Data": [
            {
                "Url": "http://test.example.com/demo.png",
                "TaskType": "refresh_url",
                "TaskId": "******",
                "State": "succeed",
                "Process": "100%",
                "CreateTime": 1721703949,
                "UpdateTime": 1721703964,
                "Msg": ""
            }
        ]
    }
}

错误码

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

服务端 SDK

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

历史版本

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